Module: Language::Python

Extended by:
Utils::Output::Mixin
Defined in:
language/python.rb

Overview

Helper functions for Python formulae.

Defined Under Namespace

Modules: Shebang, Virtualenv

Class Method Summary collapse

Methods included from Utils::Output::Mixin

odebug, odeprecated, odie, odisabled, ofail, oh1, oh1_title, ohai, ohai_title, onoe, opoo, opoo_outside_github_actions, pretty_duration, pretty_installed, pretty_outdated, pretty_uninstalled

Class Method Details

.each_python(build, &block) ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

Parameters:



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'language/python.rb', line 41

def self.each_python(build, &block)
  original_pythonpath = ENV.fetch("PYTHONPATH", nil)
  pythons = { "python@3" => "python3",
              "pypy"     => "pypy",
              "pypy3"    => "pypy3" }
  pythons.each do |python_formula, python|
    python_formula = Formulary.factory(python_formula)
    next if build.without? python_formula.to_s

    version = major_minor_version python
    ENV["PYTHONPATH"] = if python_formula.latest_version_installed?
      nil
    else
      homebrew_site_packages(python).to_s
    end
    block&.call python, version
  end
  ENV["PYTHONPATH"] = original_pythonpath
end

.homebrew_site_packages(python = "python3.7") ⇒ Pathname

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

Returns:



22
23
24
 
# File 'language/python.rb', line 22

def self.homebrew_site_packages(python = "python3.7")
  HOMEBREW_PREFIX/site_packages(python)
end

.in_sys_path?(python, path) ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

Returns:

  • (Boolean) 


81
82
83
84
85
86
87
 
# File 'language/python.rb', line 81

def self.in_sys_path?(python, path)
  script = <<~PYTHON
    import os, sys
    [os.path.realpath(p) for p in sys.path].index(os.path.realpath("#{path}"))
  PYTHON
  quiet_system python, "-c", script
end

.major_minor_version(python) ⇒ Version?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

Returns:



14
15
16
17
18
19
 
# File 'language/python.rb', line 14

def self.major_minor_version(python)
  version = `#{python} --version 2>&1`.chomp[/(\d\.\d+)/, 1]
  return unless version

  Version.new(version)
end

.reads_brewed_pth_files?(python) ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

Returns:

  • (Boolean) 


62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'language/python.rb', line 62

def self.reads_brewed_pth_files?(python)
  return false unless homebrew_site_packages(python).directory?
  return false unless homebrew_site_packages(python).writable?

  probe_file = homebrew_site_packages(python)/"homebrew-pth-probe.pth"
  begin
    probe_file.atomic_write("import site; site.homebrew_was_here = True")
    with_homebrew_path { quiet_system python, "-c", "import site; assert(site.homebrew_was_here)" }
  ensure
    probe_file.unlink if probe_file.exist?
  end
end

.setup_install_args(prefix, python = "python3") ⇒ Array<String>

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

Returns:



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'language/python.rb', line 90

def self.setup_install_args(prefix, python = "python3")
  # odeprecated "Language::Python.setup_install_args", "pip and `std_pip_args`"
  shim = <<~PYTHON
    import setuptools, tokenize
    __file__ = 'setup.py'
    exec(compile(getattr(tokenize, 'open', open)(__file__).read()
      .replace('\\r\\n', '\\n'), __file__, 'exec'))
  PYTHON
  %W[
    -c
    #{shim}
    --no-user-cfg
    install
    --prefix=#{prefix}
    --install-scripts=#{prefix}/bin
    --install-lib=#{prefix/site_packages(python)}
    --single-version-externally-managed
    --record=installed.txt
  ]
end

.site_packages(python = "python3.7") ⇒ String

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

Returns:



27
28
29
30
31
32
33
 
# File 'language/python.rb', line 27

def self.site_packages(python = "python3.7")
  if (python == "pypy") || (python == "pypy3")
    "site-packages"
  else
    "lib/python#{major_minor_version python}/site-packages"
  end
end

.user_site_packages(python) ⇒ Pathname

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

Returns:



76
77
78
 
# File 'language/python.rb', line 76

def self.user_site_packages(python)
  Pathname.new(`#{python} -c "import site; print(site.getusersitepackages())"`.chomp)
end