packing_packages.helpers package#

utils module for packing_packages.

This module provides utility functions and classes for the packing_packages package. It includes functions for checking if a package is installed, creating dummy progress bars, and checking if an argument is passed to a function.

packing_packages.helpers.check_encoding(encoding: str | None) str#

Check if the encoding is valid.

Parameters:

encoding (str) – encoding name

Returns:

encoding name

Return type:

str

packing_packages.helpers.check_env_name(env_name: str | None = None, encoding: str | None = None) str#

Check if the environment name is valid.

Parameters:
  • env_name (str, optional) – Environment name. If None, uses the current conda environment, by default None

  • encoding (str, optional) – Encoding for subprocess output. If None, uses system default encoding, by default None

Returns:

Environment name

Return type:

str

class packing_packages.helpers.dummy_tqdm(_dummy_tqdm__iterable: Iterable[T], *args, **kwargs)#

Bases: Iterable[T]

dummy class for ‘tqdm’

Parameters:

__iterable (Iterable[T]) – iterable object

packing_packages.helpers.get_env_list(encoding: str | None = None) set[str]#

Get list of conda environments.

Parameters:

encoding (str, optional) – Encoding for subprocess output. If None, uses system default encoding, by default None

Returns:

List of conda environments

Return type:

set[str]

packing_packages.helpers.is_argument(__callable: Callable[[...], Any], arg_name: str) bool#

Check to see if it is included in the callable argument.

Parameters:
  • __callable (Callable)

  • arg_name (str) – argument name

Returns:

if included, True

Return type:

bool

packing_packages.helpers.is_installed(package_name: str) bool#

Check if the package is installed.

Parameters:

package_name (str) – package name like sklearn

Returns:

if installed, True

Return type:

bool