mirror of
https://github.com/kennethreitz/pipenv.git
synced 2026-06-05 06:46:15 +00:00
Fix typos
Found via `codespell -S ./peeps,./pipenv/patched,./pipenv/vendor,./pipenv/pipenv.1,./get-pipenv.py,./tests/test_artifacts`
This commit is contained in:
+10
-10
@@ -287,7 +287,7 @@ Bug Fixes
|
|||||||
---------
|
---------
|
||||||
|
|
||||||
- Fix regression with detection of ``CI`` env variable being set to something other than a truthy value. `#5554 <https://github.com/pypa/pipenv/issues/5554>`_
|
- Fix regression with detection of ``CI`` env variable being set to something other than a truthy value. `#5554 <https://github.com/pypa/pipenv/issues/5554>`_
|
||||||
- Fix ``--categories`` argument inconsistency between requirements command and install/sync by allowing comma seperated values or spaces. `#5570 <https://github.com/pypa/pipenv/issues/5570>`_
|
- Fix ``--categories`` argument inconsistency between requirements command and install/sync by allowing comma separated values or spaces. `#5570 <https://github.com/pypa/pipenv/issues/5570>`_
|
||||||
- Use Nushell overlays when running ``pipenv shell``. `#5603 <https://github.com/pypa/pipenv/issues/5603>`_
|
- Use Nushell overlays when running ``pipenv shell``. `#5603 <https://github.com/pypa/pipenv/issues/5603>`_
|
||||||
|
|
||||||
Vendored Libraries
|
Vendored Libraries
|
||||||
@@ -497,7 +497,7 @@ Bug Fixes
|
|||||||
Features & Improvements
|
Features & Improvements
|
||||||
-----------------------
|
-----------------------
|
||||||
|
|
||||||
- Add ability for callable scripts in Pipfile under [scripts]. Callables can now be added like: ``<pathed.module>:<func>`` and can also take arguments. For exaple: ``func = {call = "package.module:func('arg1', 'arg2')"}`` then this can be activated in the shell with ``pipenv run func`` `#5294 <https://github.com/pypa/pipenv/issues/5294>`_
|
- Add ability for callable scripts in Pipfile under [scripts]. Callables can now be added like: ``<pathed.module>:<func>`` and can also take arguments. For example: ``func = {call = "package.module:func('arg1', 'arg2')"}`` then this can be activated in the shell with ``pipenv run func`` `#5294 <https://github.com/pypa/pipenv/issues/5294>`_
|
||||||
|
|
||||||
Bug Fixes
|
Bug Fixes
|
||||||
---------
|
---------
|
||||||
@@ -567,7 +567,7 @@ Behavior Changes
|
|||||||
- Remove usage of pipfile module in favour of Plette.
|
- Remove usage of pipfile module in favour of Plette.
|
||||||
pipfile is not actively maintained anymore. Plette is actively maintained,
|
pipfile is not actively maintained anymore. Plette is actively maintained,
|
||||||
and has stricter checking of the Pipefile and Pipefile.lock. As a result,
|
and has stricter checking of the Pipefile and Pipefile.lock. As a result,
|
||||||
Pipefile with unnamed package indecies will fail to lock. If a Pipefile
|
Pipefile with unnamed package indices will fail to lock. If a Pipefile
|
||||||
was hand crafeted, and the source is anonymous an error will be thrown.
|
was hand crafeted, and the source is anonymous an error will be thrown.
|
||||||
The solution is simple, add a name to your index, e.g, replace::
|
The solution is simple, add a name to your index, e.g, replace::
|
||||||
|
|
||||||
@@ -760,8 +760,8 @@ Bug Fixes
|
|||||||
- If environment variable ``CI`` or ``TF_BUILD`` is set but does not evaluate to ``False`` it is now treated as ``True``. `#5128 <https://github.com/pypa/pipenv/issues/5128>`_
|
- If environment variable ``CI`` or ``TF_BUILD`` is set but does not evaluate to ``False`` it is now treated as ``True``. `#5128 <https://github.com/pypa/pipenv/issues/5128>`_
|
||||||
- Fix auto-complete crashing on 'install' and 'uninstall' keywords `#5214 <https://github.com/pypa/pipenv/issues/5214>`_
|
- Fix auto-complete crashing on 'install' and 'uninstall' keywords `#5214 <https://github.com/pypa/pipenv/issues/5214>`_
|
||||||
- Address remaining ``pipenv`` commands that were still referencing the user or system installed ``pip`` to use the vendored ``pip`` internal to ``pipenv``. `#5229 <https://github.com/pypa/pipenv/issues/5229>`_
|
- Address remaining ``pipenv`` commands that were still referencing the user or system installed ``pip`` to use the vendored ``pip`` internal to ``pipenv``. `#5229 <https://github.com/pypa/pipenv/issues/5229>`_
|
||||||
- Use ``packages`` as contraints when locking ``dev-packages`` in Pipfile.
|
- Use ``packages`` as constraints when locking ``dev-packages`` in Pipfile.
|
||||||
Use ``packages`` as contraints when installing new ``dev-packages``. `#5234 <https://github.com/pypa/pipenv/issues/5234>`_
|
Use ``packages`` as constraints when installing new ``dev-packages``. `#5234 <https://github.com/pypa/pipenv/issues/5234>`_
|
||||||
|
|
||||||
Vendored Libraries
|
Vendored Libraries
|
||||||
------------------
|
------------------
|
||||||
@@ -903,7 +903,7 @@ Vendored Libraries
|
|||||||
Removals and Deprecations
|
Removals and Deprecations
|
||||||
-------------------------
|
-------------------------
|
||||||
|
|
||||||
- Remove more usage of misc functions of vistir. Many of this function are availabel in the STL or in another dependency of pipenv. `#5078 <https://github.com/pypa/pipenv/issues/5078>`_
|
- Remove more usage of misc functions of vistir. Many of this function are available in the STL or in another dependency of pipenv. `#5078 <https://github.com/pypa/pipenv/issues/5078>`_
|
||||||
|
|
||||||
|
|
||||||
2022.4.21 (2022-04-21)
|
2022.4.21 (2022-04-21)
|
||||||
@@ -943,7 +943,7 @@ Removals and Deprecations
|
|||||||
-------------------------
|
-------------------------
|
||||||
|
|
||||||
- Removed the vendor dependency ``more-itertools`` as it was originally added for ``zipp``, which since stopped using it. `#5044 <https://github.com/pypa/pipenv/issues/5044>`_
|
- Removed the vendor dependency ``more-itertools`` as it was originally added for ``zipp``, which since stopped using it. `#5044 <https://github.com/pypa/pipenv/issues/5044>`_
|
||||||
- Removed all usages of ``pipenv.vendor.vistir.compat.fs_str``, since this function was used for PY2-PY3 compatability and is no longer needed. `#5062 <https://github.com/pypa/pipenv/issues/5062>`_
|
- Removed all usages of ``pipenv.vendor.vistir.compat.fs_str``, since this function was used for PY2-PY3 compatibility and is no longer needed. `#5062 <https://github.com/pypa/pipenv/issues/5062>`_
|
||||||
|
|
||||||
Relates to dev process changes
|
Relates to dev process changes
|
||||||
------------------------------
|
------------------------------
|
||||||
@@ -1406,7 +1406,7 @@ Features & Improvements
|
|||||||
- Added a new environment variable, ``PIPENV_RESOLVE_VCS``, to toggle dependency resolution off for non-editable VCS, file, and URL based dependencies. `#3577 <https://github.com/pypa/pipenv/issues/3577>`_
|
- Added a new environment variable, ``PIPENV_RESOLVE_VCS``, to toggle dependency resolution off for non-editable VCS, file, and URL based dependencies. `#3577 <https://github.com/pypa/pipenv/issues/3577>`_
|
||||||
- Added the ability for Windows users to enable emojis by setting ``PIPENV_HIDE_EMOJIS=0``. `#3595 <https://github.com/pypa/pipenv/issues/3595>`_
|
- Added the ability for Windows users to enable emojis by setting ``PIPENV_HIDE_EMOJIS=0``. `#3595 <https://github.com/pypa/pipenv/issues/3595>`_
|
||||||
- Allow overriding PIPENV_INSTALL_TIMEOUT environment variable (in seconds). `#3652 <https://github.com/pypa/pipenv/issues/3652>`_
|
- Allow overriding PIPENV_INSTALL_TIMEOUT environment variable (in seconds). `#3652 <https://github.com/pypa/pipenv/issues/3652>`_
|
||||||
- Allow overriding PIP_EXISTS_ACTION evironment variable (value is passed to pip install).
|
- Allow overriding PIP_EXISTS_ACTION environment variable (value is passed to pip install).
|
||||||
Possible values here: https://pip.pypa.io/en/stable/reference/pip/#exists-action-option
|
Possible values here: https://pip.pypa.io/en/stable/reference/pip/#exists-action-option
|
||||||
Useful when you need to ``PIP_EXISTS_ACTION=i`` (ignore existing packages) - great for CI environments, where you need really fast setup. `#3738 <https://github.com/pypa/pipenv/issues/3738>`_
|
Useful when you need to ``PIP_EXISTS_ACTION=i`` (ignore existing packages) - great for CI environments, where you need really fast setup. `#3738 <https://github.com/pypa/pipenv/issues/3738>`_
|
||||||
- Pipenv will no longer forcibly override ``PIP_NO_DEPS`` on all vcs and file dependencies as resolution happens on these in a pre-lock step. `#3763 <https://github.com/pypa/pipenv/issues/3763>`_
|
- Pipenv will no longer forcibly override ``PIP_NO_DEPS`` on all vcs and file dependencies as resolution happens on these in a pre-lock step. `#3763 <https://github.com/pypa/pipenv/issues/3763>`_
|
||||||
@@ -1594,11 +1594,11 @@ Vendored Libraries
|
|||||||
Improved Documentation
|
Improved Documentation
|
||||||
----------------------
|
----------------------
|
||||||
|
|
||||||
- Added documenation about variable expansion in ``Pipfile`` entries. `#2317 <https://github.com/pypa/pipenv/issues/2317>`_
|
- Added documentation about variable expansion in ``Pipfile`` entries. `#2317 <https://github.com/pypa/pipenv/issues/2317>`_
|
||||||
- Consolidate all contributing docs in the rst file `#3120 <https://github.com/pypa/pipenv/issues/3120>`_
|
- Consolidate all contributing docs in the rst file `#3120 <https://github.com/pypa/pipenv/issues/3120>`_
|
||||||
- Update the out-dated manual page. `#3246 <https://github.com/pypa/pipenv/issues/3246>`_
|
- Update the out-dated manual page. `#3246 <https://github.com/pypa/pipenv/issues/3246>`_
|
||||||
- Move CLI docs to its own page. `#3346 <https://github.com/pypa/pipenv/issues/3346>`_
|
- Move CLI docs to its own page. `#3346 <https://github.com/pypa/pipenv/issues/3346>`_
|
||||||
- Replace (non-existant) video on docs index.rst with equivalent gif. `#3499 <https://github.com/pypa/pipenv/issues/3499>`_
|
- Replace (non-existent) video on docs index.rst with equivalent gif. `#3499 <https://github.com/pypa/pipenv/issues/3499>`_
|
||||||
- Clarify wording in Basic Usage example on using double quotes to escape shell redirection `#3522 <https://github.com/pypa/pipenv/issues/3522>`_
|
- Clarify wording in Basic Usage example on using double quotes to escape shell redirection `#3522 <https://github.com/pypa/pipenv/issues/3522>`_
|
||||||
- Ensure docs show navigation on small-screen devices `#3527 <https://github.com/pypa/pipenv/issues/3527>`_
|
- Ensure docs show navigation on small-screen devices `#3527 <https://github.com/pypa/pipenv/issues/3527>`_
|
||||||
- Added a link to the TOML Spec under General Recommendations & Version Control to clarify how Pipfiles should be written. `#3629 <https://github.com/pypa/pipenv/issues/3629>`_
|
- Added a link to the TOML Spec under General Recommendations & Version Control to clarify how Pipfiles should be written. `#3629 <https://github.com/pypa/pipenv/issues/3629>`_
|
||||||
|
|||||||
+4
-4
@@ -42,7 +42,7 @@
|
|||||||
non-deterministic resolution errors.
|
non-deterministic resolution errors.
|
||||||
2018.6.25:
|
2018.6.25:
|
||||||
- Added error handling functionality to properly cope with single-digit `Requires-Python`
|
- Added error handling functionality to properly cope with single-digit `Requires-Python`
|
||||||
metatdata with no specifiers.
|
metadata with no specifiers.
|
||||||
- Pipenv will now generate hashes much more quickly by resolving them in a single pass
|
- Pipenv will now generate hashes much more quickly by resolving them in a single pass
|
||||||
during locking.
|
during locking.
|
||||||
- `pipenv run` will now avoid spawning additional `COMSPEC` instances to run commands in
|
- `pipenv run` will now avoid spawning additional `COMSPEC` instances to run commands in
|
||||||
@@ -88,7 +88,7 @@
|
|||||||
have been fixed.
|
have been fixed.
|
||||||
- VCS dependencies are now manually obtained only if they do not match the requested ref.
|
- VCS dependencies are now manually obtained only if they do not match the requested ref.
|
||||||
- Windows executable discovery now leverages `os.pathext`.
|
- Windows executable discovery now leverages `os.pathext`.
|
||||||
- Pipenv will now correctly unqoute special characters in wheel URIs.
|
- Pipenv will now correctly unquote special characters in wheel URIs.
|
||||||
- Fixed a bug with parsing and grouping old-style setup.py extras during resolution.
|
- Fixed a bug with parsing and grouping old-style setup.py extras during resolution.
|
||||||
- Fixed a bug which caused `--system` to incorrectly abort when users were in a virtualenv.
|
- Fixed a bug which caused `--system` to incorrectly abort when users were in a virtualenv.
|
||||||
- Pipenv clean will now ignore comments when cleaning the environment.
|
- Pipenv clean will now ignore comments when cleaning the environment.
|
||||||
@@ -218,7 +218,7 @@
|
|||||||
11.4.0:
|
11.4.0:
|
||||||
- Stability.
|
- Stability.
|
||||||
- Don't install dependencies straight-away with pipenv–install — rely on the underlying pipenv sync architecture to pick up dependencies.
|
- Don't install dependencies straight-away with pipenv–install — rely on the underlying pipenv sync architecture to pick up dependencies.
|
||||||
- Warn (abord) if requested update package is not in Pipfile.
|
- Warn (abort) if requested update package is not in Pipfile.
|
||||||
- Don't configure the Pipfile for keep_outdated when update is used.
|
- Don't configure the Pipfile for keep_outdated when update is used.
|
||||||
11.3.3:
|
11.3.3:
|
||||||
- Sorry for all the bugs.
|
- Sorry for all the bugs.
|
||||||
@@ -298,7 +298,7 @@
|
|||||||
- Assume `PIPENV_VENV_IN_PROJECT` if `./.venv/` already exists.
|
- Assume `PIPENV_VENV_IN_PROJECT` if `./.venv/` already exists.
|
||||||
- Use and generate hashes for PyPI mirrors and custom indexes.
|
- Use and generate hashes for PyPI mirrors and custom indexes.
|
||||||
10.1.0:
|
10.1.0:
|
||||||
- Default dependencies now take precidence over Develop dependencies when
|
- Default dependencies now take precedence over Develop dependencies when
|
||||||
creating a Pipfile.lock.
|
creating a Pipfile.lock.
|
||||||
- Introducing `pipenv lock --keep-outdated`, which can also be passed to
|
- Introducing `pipenv lock --keep-outdated`, which can also be passed to
|
||||||
`install` and `uninstall`.
|
`install` and `uninstall`.
|
||||||
|
|||||||
+1
-1
@@ -22,7 +22,7 @@ warning: The above commands should only be used when initially creating the envi
|
|||||||
|
|
||||||
The user can provide these additional parameters:
|
The user can provide these additional parameters:
|
||||||
|
|
||||||
--dev — Install both develop and defaul` package categories from Pipfile.
|
--dev — Install both develop and default package categories from Pipfile.
|
||||||
--categories — Install packages to the category groups specified here.
|
--categories — Install packages to the category groups specified here.
|
||||||
--system — Install packages to the system site-packages rather than into your virtualenv.
|
--system — Install packages to the system site-packages rather than into your virtualenv.
|
||||||
--deploy — Verifies the _meta hash of the lock file is up to date with the ``Pipfile``, aborts install if not.
|
--deploy — Verifies the _meta hash of the lock file is up to date with the ``Pipfile``, aborts install if not.
|
||||||
|
|||||||
+1
-1
@@ -32,7 +32,7 @@ Invoke script:
|
|||||||
$ pipenv run echospam "indeed"
|
$ pipenv run echospam "indeed"
|
||||||
I am really a very silly example indeed
|
I am really a very silly example indeed
|
||||||
|
|
||||||
You can also specify pacakge functions as callables such as: `<pathed.module>:<func>`. These can also take arguments.
|
You can also specify package functions as callables such as: `<pathed.module>:<func>`. These can also take arguments.
|
||||||
For example:
|
For example:
|
||||||
|
|
||||||
[scripts]
|
[scripts]
|
||||||
|
|||||||
@@ -536,7 +536,7 @@ class Environment:
|
|||||||
|
|
||||||
def get_distributions(self) -> Generator[pkg_resources.Distribution, None, None]:
|
def get_distributions(self) -> Generator[pkg_resources.Distribution, None, None]:
|
||||||
"""
|
"""
|
||||||
Retrives the distributions installed on the library path of the environment
|
Retrieves the distributions installed on the library path of the environment
|
||||||
|
|
||||||
:return: A set of distributions found on the library path
|
:return: A set of distributions found on the library path
|
||||||
:rtype: iterator
|
:rtype: iterator
|
||||||
|
|||||||
+1
-1
@@ -75,7 +75,7 @@ NON_CATEGORY_SECTIONS = {
|
|||||||
|
|
||||||
|
|
||||||
class _LockFileEncoder(json.JSONEncoder):
|
class _LockFileEncoder(json.JSONEncoder):
|
||||||
"""A specilized JSON encoder to convert loaded TOML data into a lock file.
|
"""A specialized JSON encoder to convert loaded TOML data into a lock file.
|
||||||
|
|
||||||
This adds a few characteristics to the encoder:
|
This adds a few characteristics to the encoder:
|
||||||
|
|
||||||
|
|||||||
@@ -286,7 +286,7 @@ def convert_deps_to_pip(
|
|||||||
|
|
||||||
|
|
||||||
def get_constraints_from_deps(deps):
|
def get_constraints_from_deps(deps):
|
||||||
"""Get contraints from Pipfile-formatted dependency"""
|
"""Get constraints from Pipfile-formatted dependency"""
|
||||||
|
|
||||||
def is_constraints(dep: InstallRequirement) -> bool:
|
def is_constraints(dep: InstallRequirement) -> bool:
|
||||||
return dep.name and not dep.editable and not dep.extras
|
return dep.name and not dep.editable and not dep.extras
|
||||||
|
|||||||
+1
-1
@@ -59,7 +59,7 @@ norecursedirs = [
|
|||||||
]
|
]
|
||||||
filterwarnings = []
|
filterwarnings = []
|
||||||
# These are not all the custom markers, but most of the ones with repeat uses
|
# These are not all the custom markers, but most of the ones with repeat uses
|
||||||
# `pipenv run pytest --markers` will list all markers inlcuding these
|
# `pipenv run pytest --markers` will list all markers including these
|
||||||
markers = [
|
markers = [
|
||||||
"install: tests having to do with `pipenv install`",
|
"install: tests having to do with `pipenv install`",
|
||||||
"update: tests having to do with `pipenv update`",
|
"update: tests having to do with `pipenv update`",
|
||||||
|
|||||||
+2
-2
@@ -202,7 +202,7 @@ def generate_manual(ctx, commit=False):
|
|||||||
ctx.run("make man")
|
ctx.run("make man")
|
||||||
ctx.run("cp docs/_build/man/pipenv.1 pipenv/")
|
ctx.run("cp docs/_build/man/pipenv.1 pipenv/")
|
||||||
if commit:
|
if commit:
|
||||||
log("Commiting...")
|
log("Committing...")
|
||||||
ctx.run("git add pipenv/pipenv.1")
|
ctx.run("git add pipenv/pipenv.1")
|
||||||
ctx.run('git commit -m "Update manual page."')
|
ctx.run('git commit -m "Update manual page."')
|
||||||
|
|
||||||
@@ -212,7 +212,7 @@ def generate_contributing_md(ctx, commit=False):
|
|||||||
log("Generating CONTRIBUTING.md from reStructuredText source...")
|
log("Generating CONTRIBUTING.md from reStructuredText source...")
|
||||||
ctx.run("pandoc docs/dev/contributing.rst -f rst -t markdown -o CONTRIBUTING.md")
|
ctx.run("pandoc docs/dev/contributing.rst -f rst -t markdown -o CONTRIBUTING.md")
|
||||||
if commit:
|
if commit:
|
||||||
log("Commiting...")
|
log("Committing...")
|
||||||
ctx.run("git add CONTRIBUTING.md")
|
ctx.run("git add CONTRIBUTING.md")
|
||||||
ctx.run('git commit -m "Update CONTRIBUTING.md."')
|
ctx.run('git commit -m "Update CONTRIBUTING.md."')
|
||||||
|
|
||||||
|
|||||||
@@ -228,7 +228,7 @@ def test_man(pipenv_instance_pypi):
|
|||||||
def test_install_parse_error(pipenv_instance_private_pypi):
|
def test_install_parse_error(pipenv_instance_private_pypi):
|
||||||
with pipenv_instance_private_pypi() as p:
|
with pipenv_instance_private_pypi() as p:
|
||||||
|
|
||||||
# Make sure unparseable packages don't wind up in the pipfile
|
# Make sure unparsable packages don't wind up in the pipfile
|
||||||
# Escape $ for shell input
|
# Escape $ for shell input
|
||||||
with open(p.pipfile_path, 'w') as f:
|
with open(p.pipfile_path, 'w') as f:
|
||||||
contents = """
|
contents = """
|
||||||
|
|||||||
@@ -97,7 +97,7 @@ def test_maintain_file_line_endings(pipenv_instance_pypi, newlines):
|
|||||||
with open(fn, 'w', newline=newlines) as f:
|
with open(fn, 'w', newline=newlines) as f:
|
||||||
f.write(contents)
|
f.write(contents)
|
||||||
|
|
||||||
# Run pipenv install to programatically rewrite
|
# Run pipenv install to programmatically rewrite
|
||||||
c = p.pipenv('install chardet')
|
c = p.pipenv('install chardet')
|
||||||
assert c.returncode == 0
|
assert c.returncode == 0
|
||||||
|
|
||||||
|
|||||||
@@ -29,7 +29,7 @@ def test_get_from_env(arg, prefix, use_negation):
|
|||||||
main_expected_value = True if is_positive else None
|
main_expected_value = True if is_positive else None
|
||||||
if use_negation and not is_positive:
|
if use_negation and not is_positive:
|
||||||
main_expected_value = False
|
main_expected_value = False
|
||||||
# use negation means if the normal variable isnt set we will check
|
# use negation means if the normal variable isn't set we will check
|
||||||
# for the negated version
|
# for the negated version
|
||||||
negative_expected_value = True if is_negative else None
|
negative_expected_value = True if is_negative else None
|
||||||
if is_positive:
|
if is_positive:
|
||||||
|
|||||||
Reference in New Issue
Block a user