syspathmodif 0.0.1__tar.gz

syspathmodif-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Guyllaume Rousseau
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

syspathmodif-0.0.1/PKG-INFO

@@ -0,0 +1,48 @@
+Metadata-Version: 2.1
+Name: syspathmodif
+Version: 0.0.1
+Summary: This library offers concise manners to modify list sys.path. The user should not need to import module sys.
+Home-page: https://github.com/GRV96/syspathmodif
+Author: Guyllaume Rousseau
+License: MIT
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Utilities
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+## FRANÇAIS
+
+Cette bibliothèque offre des manières concises de modifier la liste `sys.path`.
+L'utilisateur ne devrait pas avoir besoin d'importer le module `sys`.
+
+### Contenu
+
+Les fonctions de `syspathmodif` prennent un chemin de type `str` ou
+`pathlib.Path` comme argument.
+Elles convertissent les arguments de type `pathlib.Path` en `str` puisque
+`sys.path` n'est censée contenir que des chaînes de caractères.
+
+* `sp_append` ajoute le chemin donné à la fin de `sys.path`.
+* `sp_contains` indique si `sys.path` contient le chemin donné.
+* `sp_remove` enlève le chemin donné de `sys.path`.
+
+## ENGLISH
+
+This library offers concise manners to modify list `sys.path`.
+The user should not need to import module `sys`.
+
+### Content
+
+The functions in `syspathmodif` take a path of type `str` or `pathlib.Path`
+as an argument.
+They convert arguments of type `pathlib.Path` to `str` since `sys.path` is
+supposed to contain only character strings.
+
+* `sp_append` appends the given path to the end of `sys.path`.
+* `sp_contains` indicates whether `sys.path` contains the given path.
+* `sp_remove` removes the given path from `sys.path`.

syspathmodif-0.0.1/README.md

@@ -0,0 +1,79 @@
+# syspathmodif
+
+## FRANÇAIS
+
+Cette bibliothèque offre des manières concises de modifier la liste `sys.path`.
+L'utilisateur ne devrait pas avoir besoin d'importer le module `sys`.
+
+### Contenu
+
+Les fonctions de `syspathmodif` prennent un chemin de type `str` ou
+`pathlib.Path` comme argument.
+Elles convertissent les arguments de type `pathlib.Path` en `str` puisque
+`sys.path` n'est censée contenir que des chaînes de caractères.
+
+* `sp_append` ajoute le chemin donné à la fin de `sys.path`.
+* `sp_contains` indique si `sys.path` contient le chemin donné.
+* `sp_remove` enlève le chemin donné de `sys.path`.
+
+### Démo
+
+Le script dans le dossier `demo` montre comment `syspathmodif` permet
+d'importer un paquet indisponible sans l'ajout de son chemin à `sys.path`.
+Il dépend du paquet `demo_package`.
+Lancez la démo avec la commande suivante.
+
+```
+python demo/demo.py
+```
+
+### Tests automatiques
+
+Installez `pytest`.
+```
+pip install pytest
+```
+
+Exécutez les tests.
+```
+pytest tests/test_syspathmodif.py
+```
+
+## ENGLISH
+
+This library offers concise manners to modify list `sys.path`.
+The user should not need to import module `sys`.
+
+### Content
+
+The functions in `syspathmodif` take a path of type `str` or `pathlib.Path`
+as an argument.
+They convert arguments of type `pathlib.Path` to `str` since `sys.path` is
+supposed to contain only character strings.
+
+* `sp_append` appends the given path to the end of `sys.path`.
+* `sp_contains` indicates whether `sys.path` contains the given path.
+* `sp_remove` removes the given path from `sys.path`.
+
+### Demo
+
+The script in directory `demo` shows how `syspathmodif` allows to import a
+package unavailable unless its path is added to `sys.path`.
+It depends on `demo_package`.
+Run the demo with the following command.
+
+```
+python demo/demo.py
+```
+
+### Automated Tests
+
+Install `pytest`.
+```
+pip install pytest
+```
+
+Run the tests.
+```
+pytest tests/test_syspathmodif.py
+```

syspathmodif-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

syspathmodif-0.0.1/setup.py

@@ -0,0 +1,37 @@
+import setuptools
+
+
+def _make_long_description():
+	with open("README.md", "r", encoding="utf-8") as readme_file:
+		readme_content = readme_file.read()
+
+	fr_index = readme_content.index("## FRANÇAIS")
+	fr_demos_index = readme_content.index("### Démo")
+	en_index = readme_content.index("## ENGLISH")
+	en_demos_index = readme_content.index("### Demo")
+
+	return readme_content[fr_index:fr_demos_index]\
+		+ readme_content[en_index:en_demos_index].rstrip()
+
+
+if __name__ == "__main__":
+	setuptools.setup(
+		name = "syspathmodif",
+		version = "0.0.1",
+		author = "Guyllaume Rousseau",
+		description = "This library offers concise manners to modify list sys.path. The user should not need to import module sys.",
+		long_description = _make_long_description(),
+		long_description_content_type = "text/markdown",
+		url = "https://github.com/GRV96/syspathmodif",
+		classifiers = [
+			"Development Status :: 5 - Production/Stable",
+			"Intended Audience :: Developers",
+			"License :: OSI Approved :: MIT License",
+			"Operating System :: OS Independent",
+			"Programming Language :: Python :: 3",
+			"Topic :: Software Development :: Libraries :: Python Modules",
+			"Topic :: Utilities"
+		],
+		packages = setuptools.find_packages(exclude=(".github", "demo", "demo_package",)),
+		license = "MIT",
+		license_files = ("LICENSE",))

syspathmodif-0.0.1/syspathmodif/__init__.py

@@ -0,0 +1,4 @@
+from .syspathmodif import\
+	sp_append,\
+	sp_contains,\
+	sp_remove

syspathmodif-0.0.1/syspathmodif/syspathmodif.py

@@ -0,0 +1,62 @@
+from pathlib import Path
+import sys
+
+
+def sp_append(some_path):
+	"""
+	Appends the given path to the end of list sys.path if it does not already
+	contain the path. If the path is of type pathlib.Path, it will be converted
+	to a string.
+
+	Args:
+		some_path (str or pathlib.Path): the path to append to sys.path.
+
+	Throws:
+		TypeError: if argument some_path is not of type str or pathlib.Path.
+	"""
+	some_path = _ensure_path_is_str(some_path)
+
+	if some_path not in sys.path:
+		sys.path.append(some_path)
+
+
+def sp_contains(some_path):
+	"""
+	Indicates whether list sys.path contains the given path.
+
+	Args:
+		some_path (str or pathlib.Path): the path whose presence is verified.
+
+	Returns:
+		bool: True if sys.path contains argument some_path, False otherwise.
+
+	Throws:
+		TypeError: if argument some_path is not of type str or pathlib.Path.
+	"""
+	some_path = _ensure_path_is_str(some_path)
+	return some_path in sys.path
+
+
+def sp_remove(some_path):
+	"""
+	Removes the given path from list sys.path if it contains the path.
+
+	Args:
+		some_path (str or pathlib.Path): the path to remove from sys.path.
+
+	Throws:
+		TypeError: if argument some_path is not of type str or pathlib.Path.
+	"""
+	some_path = _ensure_path_is_str(some_path)
+
+	if some_path in sys.path:
+		sys.path.remove(some_path)
+
+
+def _ensure_path_is_str(some_path):
+	if isinstance(some_path, str):
+		return some_path
+	elif isinstance(some_path, Path):
+		return str(some_path)
+	else:
+		raise TypeError("A path must be of type str or pathlib.Path.")

syspathmodif-0.0.1/syspathmodif.egg-info/PKG-INFO

@@ -0,0 +1,48 @@
+Metadata-Version: 2.1
+Name: syspathmodif
+Version: 0.0.1
+Summary: This library offers concise manners to modify list sys.path. The user should not need to import module sys.
+Home-page: https://github.com/GRV96/syspathmodif
+Author: Guyllaume Rousseau
+License: MIT
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Utilities
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+## FRANÇAIS
+
+Cette bibliothèque offre des manières concises de modifier la liste `sys.path`.
+L'utilisateur ne devrait pas avoir besoin d'importer le module `sys`.
+
+### Contenu
+
+Les fonctions de `syspathmodif` prennent un chemin de type `str` ou
+`pathlib.Path` comme argument.
+Elles convertissent les arguments de type `pathlib.Path` en `str` puisque
+`sys.path` n'est censée contenir que des chaînes de caractères.
+
+* `sp_append` ajoute le chemin donné à la fin de `sys.path`.
+* `sp_contains` indique si `sys.path` contient le chemin donné.
+* `sp_remove` enlève le chemin donné de `sys.path`.
+
+## ENGLISH
+
+This library offers concise manners to modify list `sys.path`.
+The user should not need to import module `sys`.
+
+### Content
+
+The functions in `syspathmodif` take a path of type `str` or `pathlib.Path`
+as an argument.
+They convert arguments of type `pathlib.Path` to `str` since `sys.path` is
+supposed to contain only character strings.
+
+* `sp_append` appends the given path to the end of `sys.path`.
+* `sp_contains` indicates whether `sys.path` contains the given path.
+* `sp_remove` removes the given path from `sys.path`.

syspathmodif-0.0.1/syspathmodif.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+LICENSE
+README.md
+setup.py
+syspathmodif/__init__.py
+syspathmodif/syspathmodif.py
+syspathmodif.egg-info/PKG-INFO
+syspathmodif.egg-info/SOURCES.txt
+syspathmodif.egg-info/dependency_links.txt
+syspathmodif.egg-info/top_level.txt
+tests/test_syspathmodif.py

syspathmodif-0.0.1/syspathmodif.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

syspathmodif-0.0.1/syspathmodif.egg-info/top_level.txt

@@ -0,0 +1 @@
+syspathmodif

syspathmodif-0.0.1/tests/test_syspathmodif.py

@@ -0,0 +1,87 @@
+import pytest
+
+from pathlib import Path
+import sys
+
+
+_INIT_SYS_PATH = list(sys.path)
+
+_LOCAL_DIR = Path(__file__).resolve().parent
+_REPO_ROOT = _LOCAL_DIR.parent
+_LIB_DIR = _REPO_ROOT/"syspathmodif"
+
+
+def _reset_sys_path():
+	# Copying the list is necessary to preserve the initial state.
+	sys.path = list(_INIT_SYS_PATH)
+
+
+sys.path.append(str(_REPO_ROOT))
+from syspathmodif import\
+	sp_append,\
+	sp_contains,\
+	sp_remove
+_reset_sys_path()
+
+
+def test_sp_contains_true_str():
+	# This test does not change the content of sys.path.
+	dir0 = str(sys.path[0])
+	assert sp_contains(dir0)
+
+
+def test_sp_contains_true_pathlib():
+	# This test does not change the content of sys.path.
+	dir0 = Path(sys.path[0])
+	assert sp_contains(dir0)
+
+
+def test_sp_contains_false_str():
+	# This test does not change the content of sys.path.
+	assert not sp_contains(str(_LIB_DIR))
+
+
+def test_sp_contains_false_pathlib():
+	# This test does not change the content of sys.path.
+	assert not sp_contains(_LIB_DIR)
+
+
+def test_sp_contains_exception():
+	# This test does not change the content of sys.path.
+	except_msg = "A path must be of type str or pathlib.Path."
+	with pytest.raises(TypeError, match=except_msg):
+		sp_contains(3.14159)
+
+
+def test_sp_append_str():
+	try:
+		sp_append(str(_LIB_DIR))
+		assert sp_contains(str(_LIB_DIR))
+	finally:
+		_reset_sys_path()
+
+
+def test_sp_append_pathlib():
+	try:
+		sp_append(_LIB_DIR)
+		assert sp_contains(_LIB_DIR)
+	finally:
+		_reset_sys_path()
+
+
+def test_sp_remove_str():
+	try:
+		sys.path.append(str(_LIB_DIR))
+		sp_remove(str(_LIB_DIR))
+		assert not sp_contains(str(_LIB_DIR))
+	finally:
+		_reset_sys_path()
+
+
+def test_sp_remove_pathlib():
+	try:
+		sys.path.append(str(_LIB_DIR))
+		sp_remove(_LIB_DIR)
+		assert not sp_contains(_LIB_DIR)
+	finally:
+		_reset_sys_path()