pyenv-virtualenv for Windows 1.2
A 'pyenv' plugin to manage Python virtual environments, depending on different Python versions, for various Python projects.
Loading...
Searching...
No Matches
hlp.py File Reference

Go to the source code of this file.

Namespaces

namespace  hlp
 

Functions

str hlp.fName (str natural_name)
 Convert a natural name into stripped functional name, without spaces, which is lowercase, is file name safe and is technical safe.
 
int hlp.auditPlatform (str name)
 Check if the program in running on the required platform.
 
int hlp.auditGlobalPythonVersion (str min_ver)
 Check if Python version is greater or equal the given minimal version.
 
int hlp.auditPyEnv (str min_ver)
 Check if "pyenv" version is greater or equal the given minimal version.
 
str hlp.getPyEnvVersion ()
 Get "pyenv" version.
 
(str, str) hlp.getPythonVersion ()
 Get selected global/local Python version in "pyenv".
 
str hlp.scanCwdAndAncestorsForFile (str file_name)
 Scan the CWD and its path ancestors for a specific file.
 
str hlp.getGlobalStar (str ver)
 Get the "*" marker for this version, if it is the globally selected version in "pyenv".
 
bool hlp.isPythonVenvVersion (str ver)
 Check if the Python version is capable to run virtual environment.
 
tuple[(str, None), int] hlp.selectVersionDir (str ver, str realm, venv_capable=False)
 Find the best version, matching the requirements.
 
str hlp.getColoredVenvCapability (str ver)
 Get the colored virtual environment capability str for the specific version number or path.
 
list[str] hlp.getPythonVersions (str version=' *', bool venv_capable=False, bool as_paths=False)
 Get list of installed Python version directories in "pyenv".
 
bool hlp.isJunction (str path)
 Check if path is a junction, which has been created e.g.
 
list[str] hlp.getEnvJunctions (str path)
 Scan the Pythons versions in "pyenv" for junctions, which points to a specific virtual environment directory path.
 
str hlp.getProjectPropertyFileStr (str file_path)
 Get the content of project property file.
 
int hlp.setProjectProperties (str ver, str env)
 Set/override project property files.
 
list[str] hlp.getEnvs (str ver, str name=' *', bool as_paths=False)
 Get list of installed virtual environments for a specific Python version in "pyenv".
 
list[str] hlp.getAllEnvs (str name=' *', bool as_paths=False)
 Get list of installed virtual environments for a specific Python version in "pyenv".
 
tuple[str, str, str] hlp.parseEnvDir (str env_dir)
 Parse virtual environment directory path.
 
int hlp.unsetProjectProperties ()
 Set project property files.
 
int hlp.listProjectProperties (bool show_tree=False)
 Display the table, which shows a list about project properties.
 
(tuple, tuple[str]) hlp.getTreeFoldersToExclude ()
 Get the directory tree folder names to exclude from project property file ".tree-excludes".
 

Detailed Description

Author
Michael Paul Korthals
Date
2025-07-10
Version
1.0.0

Application-specific Helper Library to deliver complex program features as single function calls for all "pyenv-virtualenv" utilities.

Definition in file hlp.py.