pythonfinder package

class pythonfinder.Finder(**data)

Bases: FinderBaseModel

create_system_path()

Return type

SystemPath

find_all_python_versions(major=None, minor=None, patch=None, pre=None, dev=None, arch=None, name=None)

Return type

list[PathEntry]

find_python_version(major=None, minor=None, patch=None, pre=None, dev=None, arch=None, name=None, sort_by_path=False)

Find the python version which corresponds most closely to the version requested.

Parameters

• major (str | int | None) – The major version to look for, or the full version, or the name of the target version.

• minor (int | None) – The minor version. If provided, disables string-based lookups from the major version field.

• patch (int | None) – The patch version.

• pre (bool | None) – If provided, specifies whether to search pre-releases.

• dev (bool | None) – If provided, whether to search dev-releases.

• arch (str | None) – If provided, which architecture to search.

• name (str | None) – Name of the target python, e.g. anaconda3-5.3.0

• sort_by_path (bool) – Whether to sort by path – default sort is by version(default: False)

Return type

PathEntry | None

Returns

A new PathEntry pointer at a matching python version, if one can be located.

global_search: bool

ignore_unsupported: bool

classmethod parse_major(major, minor=None, patch=None, pre=None, dev=None, arch=None)

Return type

dict[str, Any]

path_prepend: Optional[str]

sort_by_path: bool

system: bool

system_path: Optional[SystemPath]

which(exe)

Return type

PathEntry | None

exception pythonfinder.InvalidPythonVersion

Bases: Exception

Raised when parsing an invalid python version

class pythonfinder.SystemPath(*, global_search: bool = True, paths: Dict[str, Union[PythonFinder, PathEntry]] = None, executables_tracking: List[PathEntry] = None, python_executables_tracking: Dict[str, PathEntry] = None, path_order: List[str] = None, python_version_dict: Dict[Tuple, Any] = None, version_dict_tracking: Dict[Tuple, List[PathEntry]] = None, only_python: bool = False, pyenv_finder: Optional[PythonFinder] = None, asdf_finder: Optional[PythonFinder] = None, system: bool = False, ignore_unsupported: bool = False, finders_dict: Dict[str, PythonFinder] = None)

Bases: FinderBaseModel

class Config

Bases: object

allow_mutation = True

arbitrary_types_allowed = True

include_private_attributes = True

keep_untouched = (<class 'cached_property.cached_property'>,)

validate_assignment = True

asdf_finder: Optional[PythonFinder]

static check_for_asdf()

static check_for_pyenv()

classmethod create(path=None, system=False, only_python=False, global_search=True, ignore_unsupported=True)

Create a new pythonfinder.models.SystemPath instance.

Parameters

• path (str | None) – Search path to prepend when searching, defaults to None

• path – str, optional

• system (bool) – Whether to use the running python by default instead of searching, defaults to False

• only_python (bool) – Whether to search only for python executables, defaults to False

• ignore_unsupported (bool) – Whether to ignore unsupported python versions, if False, an error is raised, defaults to True

Return type

SystemPath

Returns

A new pythonfinder.models.SystemPath instance.

property executables: list[PathEntry]

executables_tracking: List[PathEntry]

find_all(executable)

Search the path for an executable. Return all copies.

Parameters

executable (str) – Name of the executable

Return type

list[PathEntry | PythonFinder]

Returns

List[PathEntry]

find_all_python_versions(major=None, minor=None, patch=None, pre=None, dev=None, arch=None, name=None)

Return type

list[PathEntry]

find_python_version(major=None, minor=None, patch=None, pre=None, dev=None, arch=None, name=None, sort_by_path=False)

Return type

PathEntry

property finders: list[str]

finders_dict: Dict[str, PythonFinder]

get_path(path)

Return type

PythonFinder | PathEntry

get_pythons(finder)

Return type

Iterator

global_search: bool

ignore_unsupported: bool

only_python: bool

path_entries

path_order: List[str]

paths: Dict[str, Union[PythonFinder, PathEntry]]

pyenv_finder: Optional[PythonFinder]

python_executables

python_executables_tracking: Dict[str, PathEntry]

python_version_dict: Dict[Tuple, Any]

classmethod set_defaults(values)

system: bool

version_dict

version_dict_tracking: Dict[Tuple, List[PathEntry]]

which(executable)

Search for an executable on the path.

Parameters

executable (str) – Name of the executable to be located.

Return type

PathEntry | None

Returns

PathEntry object.

Subpackages

• pythonfinder.models package
  • Submodules
    • pythonfinder.models.mixins module
      • PathEntry
        • PathEntry.Config
          • PathEntry.Config.allow_mutation
          • PathEntry.Config.arbitrary_types_allowed
          • PathEntry.Config.include_private_attributes
          • PathEntry.Config.validate_assignment
        • PathEntry.as_python
        • PathEntry.children
        • PathEntry.children_ref
        • PathEntry.create()
        • PathEntry.find_all_python_versions()
        • PathEntry.find_python_version()
        • PathEntry.get_py_version()
        • PathEntry.is_dir
        • PathEntry.is_dir_ref
        • PathEntry.is_executable
        • PathEntry.is_executable_ref
        • PathEntry.is_python
        • PathEntry.is_python_ref
        • PathEntry.is_root
        • PathEntry.name
        • PathEntry.next()
        • PathEntry.only_python
        • PathEntry.path
        • PathEntry.py_version
        • PathEntry.py_version_ref
        • PathEntry.pythons
        • PathEntry.pythons_ref
        • PathEntry.set_children()
        • PathEntry.which()
    • pythonfinder.models.path module
      • SystemPath
        • SystemPath.Config
          • SystemPath.Config.allow_mutation
          • SystemPath.Config.arbitrary_types_allowed
          • SystemPath.Config.include_private_attributes
          • SystemPath.Config.keep_untouched
          • SystemPath.Config.validate_assignment
        • SystemPath.asdf_finder
        • SystemPath.check_for_asdf()
        • SystemPath.check_for_pyenv()
        • SystemPath.create()
        • SystemPath.executables
        • SystemPath.executables_tracking
        • SystemPath.find_all()
        • SystemPath.find_all_python_versions()
        • SystemPath.find_python_version()
        • SystemPath.finders
        • SystemPath.finders_dict
        • SystemPath.get_path()
        • SystemPath.get_pythons()
        • SystemPath.global_search
        • SystemPath.ignore_unsupported
        • SystemPath.only_python
        • SystemPath.path_entries
        • SystemPath.path_order
        • SystemPath.paths
        • SystemPath.pyenv_finder
        • SystemPath.python_executables
        • SystemPath.python_executables_tracking
        • SystemPath.python_version_dict
        • SystemPath.set_defaults()
        • SystemPath.system
        • SystemPath.version_dict
        • SystemPath.version_dict_tracking
        • SystemPath.which()
      • exists_and_is_accessible()
    • pythonfinder.models.python module
      • PythonFinder
        • PythonFinder.Config
          • PythonFinder.Config.allow_mutation
          • PythonFinder.Config.arbitrary_types_allowed
          • PythonFinder.Config.include_private_attributes
          • PythonFinder.Config.validate_assignment
        • PythonFinder.create()
        • PythonFinder.find_all_python_versions()
        • PythonFinder.find_python_version()
        • PythonFinder.get_bin_dir()
        • PythonFinder.get_paths()
        • PythonFinder.get_pythons()
        • PythonFinder.get_version_order()
        • PythonFinder.ignore_unsupported
        • PythonFinder.is_asdf
        • PythonFinder.is_pyenv
        • PythonFinder.paths
        • PythonFinder.pythons
        • PythonFinder.pythons_ref
        • PythonFinder.root
        • PythonFinder.roots
        • PythonFinder.sort_function
        • PythonFinder.version_from_bin_dir()
        • PythonFinder.version_glob_path
        • PythonFinder.version_paths
        • PythonFinder.versions
        • PythonFinder.which()
      • PythonVersion
        • PythonVersion.Config
          • PythonVersion.Config.allow_mutation
          • PythonVersion.Config.arbitrary_types_allowed
          • PythonVersion.Config.include_private_attributes
          • PythonVersion.Config.validate_assignment
        • PythonVersion.architecture
        • PythonVersion.as_dict()
        • PythonVersion.as_major()
        • PythonVersion.as_minor()
        • PythonVersion.comes_from
        • PythonVersion.company
        • PythonVersion.create()
        • PythonVersion.executable
        • PythonVersion.from_path()
        • PythonVersion.from_windows_launcher()
        • PythonVersion.get_architecture()
        • PythonVersion.is_debug
        • PythonVersion.is_devrelease
        • PythonVersion.is_postrelease
        • PythonVersion.is_prerelease
        • PythonVersion.major
        • PythonVersion.matches()
        • PythonVersion.minor
        • PythonVersion.name
        • PythonVersion.parse()
        • PythonVersion.parse_executable()
        • PythonVersion.patch
        • PythonVersion.update_metadata()
        • PythonVersion.version
        • PythonVersion.version_sort
        • PythonVersion.version_tuple
      • VersionMap
        • VersionMap.Config
          • VersionMap.Config.allow_mutation
          • VersionMap.Config.arbitrary_types_allowed
          • VersionMap.Config.include_private_attributes
          • VersionMap.Config.validate_assignment
        • VersionMap.add_entry()
        • VersionMap.merge()
        • VersionMap.versions
    • pythonfinder.models.windows module

Submodules

• pythonfinder.cli module
• pythonfinder.environment module
  • SUBPROCESS_TIMEOUT
  • is_type_checking()
  • possibly_convert_to_windows_style_path()
  • set_asdf_paths()
  • set_pyenv_paths()
• pythonfinder.exceptions module
  • InvalidPythonVersion
• pythonfinder.pythonfinder module
  • Finder
    • Finder.create_system_path()
    • Finder.find_all_python_versions()
    • Finder.find_python_version()
    • Finder.global_search
    • Finder.ignore_unsupported
    • Finder.parse_major()
    • Finder.path_prepend
    • Finder.sort_by_path
    • Finder.system
    • Finder.system_path
    • Finder.which()
• pythonfinder.utils module
  • dedup()
  • ensure_path()
  • expand_paths()
  • filter_pythons()
  • get_python_version()
  • guess_company()
  • is_in_path()
  • looks_like_python()
  • normalize_path()
  • parse_asdf_version_order()
  • parse_pyenv_version_order()
  • parse_python_version()
  • path_is_executable()
  • path_is_known_executable()
  • path_is_python()
  • path_is_pythoncore()
  • split_version_and_name()
  • unnest()