Class Codebase

src/commoncode/resource.py:233–1175

Represent a codebase being scanned. A Codebase is a list of Resources.

class Codebase:
    """
    Represent a codebase being scanned. A Codebase is a list of Resources.
    """

    # we do not really need slots but this is a way to ensure we have tight
    # control on object attributes
    __slots__ = (
        "max_depth",
        "location",
        "includes",
        "ignores",
        "has_single_resource",
        "resource_attributes",
        "resource_class",
        "root",
        "is_file",
        "temp_dir",
        "resources_by_path",
        "resources_count",
        "paths",
        "max_in_memory",
        "all_in_memory",
        "all_on_disk",
        "cache_dir",
        "headers",
        "current_header",
        "codebase_attributes",
        "attributes",
        "counters",
        "timings",
        "errors",
    )

    # the value returned if the resource is cached
    CACHED_RESOURCE = 1

    def __init__(
        self,
        location,
        resource_attributes=None,
        codebase_attributes=None,
        temp_dir=temp_dir,
        max_in_memory=10000,
        max_depth=0,
        paths=tuple(),
        ignores=tuple(),
        includes=tuple(),
        *args,
        **kwargs,
    ):
        """
        Initialize a new codebase rooted at the ``location`` existing file or
        directory.

        Use an optional list of ``paths`` strings that are paths relative to the
        root ``location`` such that joining the root ``location`` and such a
        path is the ``location`` of this path. If these ``paths`` are provided,