Class: Dependabot::Python::LanguageVersionManager

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

Constant Summary collapse

PRE_INSTALLED_PYTHON_VERSIONS =

This list must match the versions specified at the top of ‘python/Dockerfile`

%w(
  3.13.1
  3.12.7
  3.11.9
  3.10.15
  3.9.18
  3.8.20
).freeze

Instance Method Summary collapse

Constructor Details

#initialize(python_requirement_parser:) ⇒ LanguageVersionManager

Returns a new instance of LanguageVersionManager.



23
24
25
 
# File 'lib/dependabot/python/language_version_manager.rb', line 23

def initialize(python_requirement_parser:)
  @python_requirement_parser = python_requirement_parser
end

Instance Method Details

#install_required_python ⇒ Object 



28
29
30
31
32
33
34
35
 
# File 'lib/dependabot/python/language_version_manager.rb', line 28

def install_required_python
  # The leading space is important in the version check
  return if SharedHelpers.run_shell_command("pyenv versions").include?(" #{python_major_minor}.")

  SharedHelpers.run_shell_command(
    "tar -axf /usr/local/.pyenv/versions/#{python_version}.tar.zst -C /usr/local/.pyenv/versions"
  )
end

#installed_version ⇒ Object 



38
39
40
41
42
43
44
 
# File 'lib/dependabot/python/language_version_manager.rb', line 38

def installed_version
  # Use `pyenv exec` to query the active Python version
  output, _status = SharedHelpers.run_shell_command("pyenv exec python --version")
  version = output.strip.split.last # Extract the version number (e.g., "3.13.1")

  T.must(version)
end

#python_major_minor ⇒ Object 



47
48
49
 
# File 'lib/dependabot/python/language_version_manager.rb', line 47

def python_major_minor
  @python_major_minor ||= T.let(T.must(Python::Version.new(python_version).segments[0..1]).join("."), T.untyped)
end

#python_requirement_string ⇒ Object 



57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/dependabot/python/language_version_manager.rb', line 57

def python_requirement_string
  if user_specified_python_version
    if user_specified_python_version.start_with?(/\d/)
      parts = user_specified_python_version.split(".")
      parts.fill("*", (parts.length)..2).join(".")
    else
      user_specified_python_version
    end
  else
    python_version_matching_imputed_requirements || PRE_INSTALLED_PYTHON_VERSIONS.first
  end
end

#python_version ⇒ Object 



52
53
54
 
# File 'lib/dependabot/python/language_version_manager.rb', line 52

def python_version
  @python_version ||= T.let(python_version_from_supported_versions, T.nilable(String))
end

#python_version_from_supported_versions ⇒ Object

Raises:

  • (ToolVersionNotSupported) 


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

def python_version_from_supported_versions
  requirement_string = python_requirement_string

  # If the requirement string isn't already a range (eg ">3.10"), coerce it to "major.minor.*".
  # The patch version is ignored because a non-matching patch version is unlikely to affect resolution.
  requirement_string = requirement_string.gsub(/\.\d+$/, ".*") if requirement_string.start_with?(/\d/)

  # Try to match one of our pre-installed Python versions
  requirement = T.must(Python::Requirement.requirements_array(requirement_string).first)
  version = PRE_INSTALLED_PYTHON_VERSIONS.find { |v| requirement.satisfied_by?(Python::Version.new(v)) }
  return version if version

  # Otherwise we have to raise
  supported_versions = PRE_INSTALLED_PYTHON_VERSIONS.map { |x| x.gsub(/\.\d+$/, ".*") }.join(", ")
  raise ToolVersionNotSupported.new("Python", python_requirement_string, supported_versions)
end

#python_version_matching(requirements) ⇒ Object 



103
104
105
106
107
108
109
110
111
112
 
# File 'lib/dependabot/python/language_version_manager.rb', line 103

def python_version_matching(requirements)
  PRE_INSTALLED_PYTHON_VERSIONS.find do |version_string|
    version = Python::Version.new(version_string)
    requirements.all? do |req|
      next req.any? { |r| r.satisfied_by?(version) } if req.is_a?(Array)

      req.satisfied_by?(version)
    end
  end
end

#python_version_matching_imputed_requirements ⇒ Object 



94
95
96
97
98
99
100
 
# File 'lib/dependabot/python/language_version_manager.rb', line 94

def python_version_matching_imputed_requirements
  compiled_file_python_requirement_markers =
    @python_requirement_parser.imputed_requirements.map do |r|
      Dependabot::Python::Requirement.new(r)
    end
  python_version_matching(compiled_file_python_requirement_markers)
end

#user_specified_python_version ⇒ Object 



89
90
91
 
# File 'lib/dependabot/python/language_version_manager.rb', line 89

def user_specified_python_version
  @python_requirement_parser.user_specified_requirements.first
end