structlint.configuration
Configuration types and helper functions.
Goal is to perform strict validation and helpful error messages.
DocsConfig
dataclass
allow_additional: re.Pattern = Regex.MATCH_NOTHING
class-attribute
instance-attribute
Whether/which additional documentation files and objects should be allowed.
file_per_directory: re.Pattern = Regex.MATCH_NOTHING
class-attribute
instance-attribute
Regular expression matching any directories that should be collapsed to a single .md file.
file_per_class: re.Pattern = Regex.MATCH_NOTHING
class-attribute
instance-attribute
Regular expression matching any classes (including path) that should be promoted to thir own .md file.
ignore: re.Pattern = Regex.MATCH_NOTHING
class-attribute
instance-attribute
Regular expression matching any files or objects that should not be included in the analysis of documentation structure.
md_dir: Path = Path('docs/md')
class-attribute
instance-attribute
ImportInfo
ImportsConfig
internal_allowed_everywhere = set(map(self._fixer, internal_allowed_everywhere or set()))
instance-attribute
external_allowed_everywhere = set(external_allowed_everywhere or set())
instance-attribute
grimp_cache = grimp_cache
instance-attribute
MethodsConfig
dataclass
normal: float = NORMAL_DEFAULT
class-attribute
instance-attribute
ordering: tuple[tuple[re.Pattern, float], ...] = BUILTINS
class-attribute
instance-attribute
UnitTestsConfig
dataclass
allow_additional: re.Pattern = field(default=Regex.MATCH_NOTHING)
class-attribute
instance-attribute
file_per_directory: re.Pattern = field(default=Regex.MATCH_NOTHING)
class-attribute
instance-attribute
file_per_class: re.Pattern = field(default=Regex.MATCH_NOTHING)
class-attribute
instance-attribute
ignore: re.Pattern = field(default=Regex.MATCH_NOTHING)
class-attribute
instance-attribute
Configuration
dataclass
Top-level configuration object containing all settings necessary to execute all checks.