Class: Dependabot::Python::UpdateChecker::PipCompileVersionResolver

Inherits:
Object
  • Object
show all
Extended by:
T::Sig
Defined in:
lib/dependabot/python/update_checker/pip_compile_version_resolver.rb

Overview

This class does version resolution for pip-compile. Its approach is:

  • Unlock the dependency we’re checking in the requirements.in file

  • Run ‘pip-compile` and see what the result is

Constant Summary collapse

GIT_DEPENDENCY_UNREACHABLE_REGEX = 
T.let(/git clone --filter=blob:none --quiet (?<url>[^\s]+).* /, Regexp)
GIT_REFERENCE_NOT_FOUND_REGEX = 
T.let(/Did not find branch or tag '(?<tag>[^\n"]+)'/m, Regexp)
NATIVE_COMPILATION_ERROR = 
T.let(
  "pip._internal.exceptions.InstallationSubprocessError: Getting requirements to build wheel exited with 1",
  String
)
PYTHON_PACKAGE_NAME_REGEX =

See packaging.python.org/en/latest/tutorials/packaging-projects/#configuring-metadata

T.let(/[A-Za-z0-9_\-]+/, Regexp)
RESOLUTION_IMPOSSIBLE_ERROR = 
T.let("ResolutionImpossible", String)
ERROR_REGEX = 
T.let(/(?<=ERROR\:\W).*$/, Regexp)

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(dependency:, dependency_files:, credentials:, repo_contents_path:) ⇒ PipCompileVersionResolver

Returns a new instance of PipCompileVersionResolver.



64
65
66
67
68
69
70
71
 
# File 'lib/dependabot/python/update_checker/pip_compile_version_resolver.rb', line 64

def initialize(dependency:, dependency_files:, credentials:, repo_contents_path:)
  @dependency = T.let(dependency, Dependabot::Dependency)
  @dependency_files = T.let(dependency_files, T::Array[Dependabot::DependencyFile])
  @credentials = T.let(credentials, T::Array[Dependabot::Credential])
  @repo_contents_path = T.let(repo_contents_path, T.nilable(String))
  @build_isolation = T.let(true, T::Boolean)
  @error_handler = T.let(PipCompileErrorHandler.new, PipCompileErrorHandler)
end

Instance Attribute Details

#credentials ⇒ Object (readonly)

Returns the value of attribute credentials.



48
49
50
 
# File 'lib/dependabot/python/update_checker/pip_compile_version_resolver.rb', line 48

def credentials
  @credentials
end

#dependency ⇒ Object (readonly)

Returns the value of attribute dependency.



42
43
44
 
# File 'lib/dependabot/python/update_checker/pip_compile_version_resolver.rb', line 42

def dependency
  @dependency
end

#dependency_files ⇒ Object (readonly)

Returns the value of attribute dependency_files.



45
46
47
 
# File 'lib/dependabot/python/update_checker/pip_compile_version_resolver.rb', line 45

def dependency_files
  @dependency_files
end

#error_handler ⇒ Object (readonly)

Returns the value of attribute error_handler.



54
55
56
 
# File 'lib/dependabot/python/update_checker/pip_compile_version_resolver.rb', line 54

def error_handler
  @error_handler
end

#repo_contents_path ⇒ Object (readonly)

Returns the value of attribute repo_contents_path.



51
52
53
 
# File 'lib/dependabot/python/update_checker/pip_compile_version_resolver.rb', line 51

def repo_contents_path
  @repo_contents_path
end

Instance Method Details

#latest_resolvable_version(requirement: nil) ⇒ Object 



74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/dependabot/python/update_checker/pip_compile_version_resolver.rb', line 74

def latest_resolvable_version(requirement: nil)
  @latest_resolvable_version_string ||= T.let(
    {},
    T.nilable(T::Hash[T.nilable(String), T.nilable(Dependabot::Python::Version)])
  )
  return @latest_resolvable_version_string[requirement] if @latest_resolvable_version_string.key?(requirement)

  version_string =
    fetch_latest_resolvable_version_string(requirement: requirement)

  @latest_resolvable_version_string[requirement] ||=
    version_string.nil? ? nil : Python::Version.new(version_string)
end

#resolvable?(version:) ⇒ Boolean

Returns:

  • (Boolean) 


89
90
91
92
93
94
95
96
97
98
 
# File 'lib/dependabot/python/update_checker/pip_compile_version_resolver.rb', line 89

def resolvable?(version:)
  @resolvable ||= T.let({}, T.nilable(T::Hash[Gem::Version, T::Boolean]))
  return T.must(@resolvable[version]) if @resolvable.key?(version)

  @resolvable[version] = if latest_resolvable_version(requirement: "==#{version}")
                           true
                         else
                           false
                         end
end