Spec-Zone.ru › Homebrew

Модуль: Language::Python::Virtualenv Приватный

Расширяет:
T::Helpers
Определён в:
language/python.rb

Обзор

Этот модуль является частью приватного API. Этот модуль можно использовать только в репозитории Homebrew/brew. Сторонним разработчикам по возможности не следует использовать этот модуль, поскольку он может быть удалён или изменён без предупреждения.

Модуль примеси для Formula, добавляющий возможности поддержки virtualenv.

Определено в пространстве имён

Классы: Virtualenv

Краткое описание методов экземпляра свернуть

  • #needs_python?(python) ⇒ Boolean приватный

    Возвращает true, если параметр formula для указанного python активен в данный момент или если указанный python требуется формуле.

  • #python_names ⇒ Array<String> приватный
  • #virtualenv_create(venv_root, python = "python", formula = T.cast(self, Formula), system_site_packages: true, without_pip: true) ⇒ Virtualenv приватный

    Создаёт объект Virtualenv и передаёт его в блок для использования в Formula#install. Объект предоставляет вспомогательные методы для создания виртуального окружения Python и установки в него пакетов.

  • #virtualenv_install_with_resources(using: nil, system_site_packages: true, without_pip: true, link_manpages: true, without: nil, start_with: nil, end_with: nil) ⇒ Virtualenv приватный

    Вспомогательный метод для стандартного случая установки приложения Python.

Подробное описание методов экземпляра

#needs_python?(python) ⇒ Boolean

Этот метод является частью приватного API. Этот метод можно использовать только в репозитории Homebrew/brew. Сторонним разработчикам по возможности не следует использовать этот метод, поскольку он может быть удалён или изменён без предупреждения.

Возвращает true, если параметр formula для указанного python активен в данный момент или если указанный python требуется формуле. Допустимые значения: "python", "python2" и :python3. Обратите внимание, что параметры formula "with-python", "without-python", "with-python@2" и "without-python@2" обрабатываются корректно, даже если с ними не связано соответствующее выражение depends_on.

Параметры:

  • python (String)

Возвращает:

  • (Boolean)


205
206
207
208
209
# File 'language/python.rb', line 205

def needs_python?(python)
  return true if build.with?(python)

  (requirements.to_a | deps).any? { |r| Utils.name_from_full_name(r.name) == python && r.required? }
end

#python_names ⇒ Array<String>

Этот метод является частью приватного API. Этот метод можно использовать только в репозитории Homebrew/brew. Сторонним разработчикам по возможности не следует использовать этот метод, поскольку он может быть удалён или изменён без предупреждения.

Возвращает:

  • (Array<String>)


261
262
263
# File 'language/python.rb', line 261

def python_names
  %w[pythonpython3pypypypy3] + Formula.names.select { |name| name.start_with? "python@" }
end

#virtualenv_create(venv_root, python = "python", formula = T.cast(self, Formula), system_site_packages: true, without_pip: true) ⇒ Virtualenv

Этот метод является частью приватного API. Этот метод можно использовать только в репозитории Homebrew/brew. Сторонним разработчикам по возможности не следует использовать этот метод, поскольку он может быть удалён или изменён без предупреждения.

Создаёт объект Virtualenv и передаёт его в блок для использования в Formula#install. Объект предоставляет вспомогательные методы для создания виртуального окружения Python и установки в него пакетов.

Параметры:

  • venv_root (String, Pathname) —

    путь к корню virtualenv (часто libexec/"venv")

  • python (String, Pathname) (по умолчанию: "python") —

    используемый интерпретатор (например, "python3" или "python3.x")

  • formula (Formula) (по умолчанию: T.cast(self, Formula)) —

    активная Formula

  • system_site_packages (Boolean) (по умолчанию: true)
  • without_pip (Boolean) (по умолчанию: true)

Возвращает:

  • (Virtualenv) —

    экземпляр Virtualenv



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
# File 'language/python.rb', line 159

def virtualenv_create(venv_root, python = "python", formula = T.cast(self, Formula),
                      system_site_packages: true, without_pip: true)
  # Limit deprecation to 3.12+ for now (or if we can't determine the version).
  # Some used this argument for `setuptools`, which we no longer bundle since 3.12.
  unless without_pip
    python_version = Language::Python.major_minor_version(python)
    if python_version.nil? || python_version.null? || python_version >= "3.12"
      raise ArgumentError, "virtualenv_create's without_pip is deprecated starting with Python 3.12"
    end
  end

  ENV.refurbish_args
  venv = Virtualenv.new formula, venv_root, python
  venv.create(system_site_packages:, without_pip:)

  # Find any Python bindings provided by recursive dependencies
  pth_contents = []
  formula.recursive_dependencies do |dependent, dep|
    next Dependable::PRUNE if dep.build? || dep.test?
    # Apply default filter
    next Dependable::PRUNE if (dep.optional? || dep.recommended?) && !T.cast(dependent,
                                                                             Formula).build.with?(dep)
    # Do not add the main site-package provided by the brewed
    # Python formula, to keep the virtual-env's site-package pristine
    next Dependable::PRUNE if python_names.include? dep.name
    # Skip uses_from_macos dependencies as these imply no Python bindings
    next Dependable::PRUNE if dep.uses_from_macos?

    dep_site_packages = dep.to_formula.opt_prefix/Language::Python.site_packages(python)
    next Dependable::PRUNE unless dep_site_packages.exist?

    pth_contents << "import site; site.addsitedir('#{dep_site_packages}')\n"
    nil # Return nil to satisfy T.nilable(Symbol) block sig (Array from << would violate it).
  end
  (venv.site_packages/"homebrew_deps.pth").write pth_contents.join unless pth_contents.empty?

  venv
end

#virtualenv_install_with_resources(using: nil, system_site_packages: true, without_pip: true, link_manpages: true, without: nil, start_with: nil, end_with: nil) ⇒ Virtualenv

Этот метод является частью приватного API. Этот метод можно использовать только в репозитории Homebrew/brew. Сторонним разработчикам по возможности не следует использовать этот метод, поскольку он может быть удалён или изменён без предупреждения.

Вспомогательный метод для стандартного случая установки приложения Python. Создаёт virtualenv в libexec, устанавливает все resources, определённые в формуле, а затем устанавливает саму формулу. Можно передать хеш параметров (например, :using => "python"), чтобы переопределить предпочтение формулы Python или python@x.y, выбранное по умолчанию, либо разрешить неоднозначную ситуацию, когда неясно, следует ли по умолчанию выбрать python или python@x.y.

Параметры:

  • using (String, nil) (по умолчанию: nil)
  • system_site_packages (Boolean) (по умолчанию: true)
  • without_pip (Boolean) (по умолчанию: true)
  • link_manpages (Boolean) (по умолчанию: true)
  • without (String, Array<String>, nil) (по умолчанию: nil)
  • start_with (String, Array<String>, nil) (по умолчанию: nil)
  • end_with (String, Array<String>, nil) (по умолчанию: nil)

Возвращает:

  • (Virtualenv)


229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
# File 'language/python.rb', line 229

def virtualenv_install_with_resources(using: nil, system_site_packages: true, without_pip: true,
                                      link_manpages: true, without: nil, start_with: nil, end_with: nil)
  python = using
  if python.nil?
    wanted = python_names.select { |py| needs_python?(py) }
    raise FormulaUnknownPythonError, self if wanted.empty?
    raise FormulaAmbiguousPythonError, self if wanted.size > 1

    python = wanted.fetch(0)
    python = "python3" if python == "python"
  end

  venv_resources = if without.nil? && start_with.nil? && end_with.nil?
    resources
  else
    remaining_resources = resources.to_h { |resource| [resource.name, resource] }

    slice_resources!(remaining_resources, Array(without))
    start_with_resources = slice_resources!(remaining_resources, Array(start_with))
    end_with_resources = slice_resources!(remaining_resources, Array(end_with))

    start_with_resources + remaining_resources.values + end_with_resources
  end

  venv = virtualenv_create(libexec, python.delete("@"), system_site_packages:,
                                                        without_pip:)
  venv.pip_install venv_resources
  venv.pip_install_and_link(T.must(buildpath), link_manpages:)
  venv
end

© 2009–present Homebrew contributors
Licensed under the BSD 2-Clause License.
https://docs.brew.sh/rubydoc/Language/Python/Virtualenv.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API