cli-command-parser 2024.5.31__tar.gz → 2024.8.17__tar.gz

{cli_command_parser-2024.5.31/lib/cli_command_parser.egg-info → cli_command_parser-2024.8.17}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cli_command_parser
-Version: 2024.5.31
+Version: 2024.8.17
 Summary: CLI Command Parser
 Home-page: https://github.com/dskrypa/cli_command_parser
 Author: Doug Skrypa

{cli_command_parser-2024.5.31 → cli_command_parser-2024.8.17}/lib/cli_command_parser/__version__.py

@@ -1,7 +1,7 @@
 __title__ = 'cli_command_parser'
 __description__ = 'CLI Command Parser'
 __url__ = 'https://github.com/dskrypa/cli_command_parser'
-__version__ = '2024.05.31'
+__version__ = '2024.08.17'
 __author__ = 'Doug Skrypa'
 __author_email__ = 'dskrypa@gmail.com'
 __license__ = 'Apache 2.0'

{cli_command_parser-2024.5.31 → cli_command_parser-2024.8.17}/lib/cli_command_parser/documentation.py

@@ -10,6 +10,7 @@ import logging
 import sys
 from abc import ABC
 from collections import defaultdict
+from fnmatch import fnmatch
 from importlib.util import module_from_spec, spec_from_file_location
 from pathlib import Path
 from typing import TYPE_CHECKING, Any, Iterable, Mapping
@@ -170,7 +171,7 @@ class RstWriter:
     :param ext: The file extension / suffix (including the leading ``.``) to use for output.
     :param module_template: The format string to use when generating RST for Python modules.
     :param skip_modules: A collection of module names (using ``package.module`` notation) that should be skipped
-      when documenting a Python package via :meth:`.document_package`.
+      when documenting a Python package via :meth:`.document_package`.  Supports fnmatch / glob wildcards.
     """
 
     def __init__(
@@ -319,11 +320,13 @@ class RstWriter:
         for path in pkg_path.iterdir():
             if path.is_dir():
                 sub_pkg_name = f'{pkg_name}.{path.name}'
-                if self.document_package(sub_pkg_name, path, subdir, max_depth=max_depth):
+                if sub_pkg_name in self.skip_modules or any(fnmatch(sub_pkg_name, pat) for pat in self.skip_modules):
+                    continue
+                elif self.document_package(sub_pkg_name, path, subdir, max_depth=max_depth):
                     contents.append(sub_pkg_name)
             elif path.is_file() and path.suffix == '.py' and not path.name.startswith('__'):
                 name = f'{pkg_name}.{path.stem}'
-                if name in self.skip_modules:
+                if name in self.skip_modules or any(fnmatch(name, pat) for pat in self.skip_modules):
                     continue
                 contents.append(name)
                 self.document_module(name, subdir)

{cli_command_parser-2024.5.31 → cli_command_parser-2024.8.17}/lib/cli_command_parser/inputs/files.py

@@ -85,15 +85,18 @@ class FileInput(InputType[T], ABC):
             path = path.resolve()
         if self.exists is not None:
             if self.exists and not path.exists():
-                raise InputValidationError('it does not exist')
+                raise InputValidationError('the provided path does not exist')
             elif not self.exists and path.exists():
-                raise InputValidationError('it already exists')
+                raise InputValidationError('the provided path already exists')
+
         if self.type != StatMode.ANY and path.exists() and not self.type.matches(path.stat().st_mode):
+            # TODO: Indicate what the discovered type was
             raise InputValidationError(f'expected a {self.type}')
+
         if self.readable and not os.access(path, os.R_OK):
-            raise InputValidationError('it is not readable')
+            raise InputValidationError('the provided path is not readable')
         if self.writable and not os.access(path, os.W_OK):
-            raise InputValidationError('it is not writable')
+            raise InputValidationError('the provided path is not writable')
         return path
 
 

{cli_command_parser-2024.5.31 → cli_command_parser-2024.8.17/lib/cli_command_parser.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cli_command_parser
-Version: 2024.5.31
+Version: 2024.8.17
 Summary: CLI Command Parser
 Home-page: https://github.com/dskrypa/cli_command_parser
 Author: Doug Skrypa