Module packagelister.packagelister

Functions

def scan(project_dir: pathlib.Path | str = None) ‑> dict

Recursively scans a directory for python files to determine what 3rd-party packages are in use, as well as the version number if applicable.

Returns a dictionary where the keys are package names and the values are the version number of the package if there is one (None if there isn't) and a list of the files that import the package.

:param project_dir: Can be an absolute or relative path to a directory or a single file (.py). If it is relative, it will be assumed to be relative to the current working directory. If an argument isn't given, the current working directory will be scanned. If the path doesn't exist, an empty dictionary is returned.

Expand source code

def scan(project_dir: Path | str = None) -> dict:
    """Recursively scans a directory for python files to determine
    what 3rd-party packages are in use, as well as the version number
    if applicable.

    Returns a dictionary where the keys are package
    names and the values are the version number of the package if there is one
    (None if there isn't) and a list of the files that import the package.

    :param project_dir: Can be an absolute or relative path
    to a directory or a single file (.py).
    If it is relative, it will be assumed to be relative to
    the current working directory.
    If an argument isn't given, the current working directory
    will be scanned.
    If the path doesn't exist, an empty dictionary is returned."""
    if not project_dir:
        project_dir = Path.cwd()
    elif type(project_dir) is str:
        project_dir = Path(project_dir)
    if not project_dir.is_absolute():
        project_dir = project_dir.absolute()

    # Return empty dict if project_dir doesn't exist
    if not project_dir.exists():
        return {}
    # You can scan a non python file one at a time if you reeeally want to.
    if project_dir.is_file():
        files = [project_dir]
    else:
        files = [file for file in crawl(project_dir) if file.suffix == ".py"]

    bar = ProgBar(len(files) - 1, width_ratio=0.33)
    # If scanning one file, the progress bar will show 0% complete if bar.counter == 0
    if len(files) == 1:
        bar.counter = 1
    packages = {}
    standard_lib = list(sys.stdlib_module_names)
    for file in files:
        bar.display(suffix=f"Scanning {file.name}")
        contents = [
            line.split()[1]
            for line in file.read_text(encoding="utf-8").splitlines()
            if line.startswith(("from", "import"))
        ]
        for package in contents:
            if package.startswith("."):
                package = package[1:]
            if "." in package:
                package = package[: package.find(".")]
            if "," in package:
                package = package[:-1]
            if file.with_stem(package) not in files and package not in standard_lib:
                if package in packages and str(file) not in packages[package]["files"]:
                    packages[package]["files"].append(str(file))
                else:
                    try:
                        package_version = importlib.metadata.version(package)
                    except Exception as e:
                        package_version = None
                    packages[package] = {
                        "files": [str(file)],
                        "version": package_version,
                    }
    return packages