exclusions Namespace Reference

Variables
dict	COMMON_EXCLUDE_DIRS
dict	LINTER_EXCLUDE_DIRS
dict	EXPORTER_EXCLUDE_DIRS
list	WILDCARD_EXCLUDE_DIRS = ["cache", "_source", "_skeleton", "logs", "_exports", "_build", ".venv", "venv"]
list	NEVER_EXPORT_FILE_PATTERNS
tuple	GIT_IGNORE_DEFAULTS

Detailed Description

Purpose
-------
Provide shared default directory exclusion lists for linter and exporter.

Responsibilities
----------------
- Define common exclusion directories used by both the linter and the source exporter.
- Provide tool-specific supersets for each consumer.
- Centralise wildcard (substring) exclusion patterns.

Diagnostics
-----------
Domain: OCT-CORE
Levels:
    L2 - lifecycle
    L3 - semantic details
    L4 - deep tracing

Contracts
---------
- All sets are frozen at module level; consumers copy before mutating.
- Linter and exporter import from here instead of defining their own constants.

Dependencies
------------
- oct.core.diagnostics (_dbg structured logger; imported but never called, the module holds constants only)

Variable Documentation

COMMON_EXCLUDE_DIRS

dict exclusions.COMMON_EXCLUDE_DIRS

Initial value:

=  {
    ".git",
    "__pycache__",
    "Old",
    "old",
    ".linter_archive",
    "copied_python_files",
    "data",
    "data_raw",
    "raw_data",
    "data.bk",
    "flow_charts",
    "dot_files",
    "dev-tools",
    # Virtual environment directories - must be excluded to avoid scanning
    # thousands of third-party library files on every lint or export run.
    ".venv",
    "venv",
    "env",
}

Definition at line 39 of file exclusions.py.

EXPORTER_EXCLUDE_DIRS

dict exclusions.EXPORTER_EXCLUDE_DIRS

Initial value:

=  COMMON_EXCLUDE_DIRS | {
    "Code Reviews",
    "dataset_library",
    "doxygen_work_dir",
    "doxygen_output",
    "logs",
    "cache",
    "_backup",
    "old_backup",
}

Definition at line 70 of file exclusions.py.

GIT_IGNORE_DEFAULTS

tuple exclusions.GIT_IGNORE_DEFAULTS

Definition at line 114 of file exclusions.py.

LINTER_EXCLUDE_DIRS

dict exclusions.LINTER_EXCLUDE_DIRS

Initial value:

=  COMMON_EXCLUDE_DIRS | {
    "Code Reviews",
    "fixtures",
}

Definition at line 64 of file exclusions.py.

NEVER_EXPORT_FILE_PATTERNS

list exclusions.NEVER_EXPORT_FILE_PATTERNS

Initial value:

=  [
    ".env", ".env.*",           # Environment variable files
    "*.pem", "*.key",           # Private key files
    "credentials.json",         # Service account credentials
    "secrets.json",             # Application secrets
    "secrets.yaml",             # Application secrets (YAML)
    "secrets.yml",              # Application secrets (YAML)
]

Definition at line 91 of file exclusions.py.

WILDCARD_EXCLUDE_DIRS

list exclusions.WILDCARD_EXCLUDE_DIRS = ["cache", "_source", "_skeleton", "logs", "_exports", "_build", ".venv", "venv"]

Definition at line 85 of file exclusions.py.