pylint.testutils._primer.PackageToLint

class documentation

class PackageToLint: (source)

View In Hierarchy

Represents data about a package to be tested during primer tests.

Method __init__ Undocumented
Method lazy_clone Concatenates the target directory and clones the file.
Instance Variable branch Branch of the repository to clone.
Instance Variable commit Commit hash to pin the repository on.
Instance Variable directories Directories within the repository to run pylint over.
Instance Variable minimum_python Minimum python version supported by the package.
Instance Variable pylint_additional_args Arguments to give to pylint.
Instance Variable pylintrc_relpath Path relative to project's main directory to the pylintrc if it exists.
Instance Variable url URL of the repository to clone.
Property clone_directory Directory to clone repository into.
Property paths_to_lint The paths we need to lint.
Property pylint_args Undocumented
Property pylintrc Undocumented
Method _clone_repository Undocumented
Method _pull_repository Undocumented
def __init__(self, url: str, branch: str, directories: list[str], commit: str|None = None, pylint_additional_args: list[str]|None = None, pylintrc_relpath: str|None = None, minimum_python: str|None = None): (source)

Undocumented

def lazy_clone(self) -> str: (source)

Concatenates the target directory and clones the file. Not expected to be tested as the primer won't work if it doesn't. It's tested in the continuous integration primers, only the coverage is not calculated on everything. If lazy clone breaks for local use we'll probably notice because we'll have a fatal when launching the primer locally.

branch = (source)

Branch of the repository to clone.

commit = (source)

Commit hash to pin the repository on.

directories = (source)

Directories within the repository to run pylint over.

minimum_python = (source)

Minimum python version supported by the package.

pylint_additional_args = (source)

Arguments to give to pylint.

pylintrc_relpath = (source)

Path relative to project's main directory to the pylintrc if it exists.

url = (source)

URL of the repository to clone.

@property
clone_directory: Path = (source)

Directory to clone repository into.

@property
paths_to_lint: list[str] = (source)

The paths we need to lint.

@property
pylint_args: list[str] = (source)

Undocumented

@property
pylintrc: Path|Literal[''] = (source)

Undocumented

def _clone_repository(self) -> str: (source)

Undocumented

def _pull_repository(self) -> str: (source)

Undocumented