A file utility for accessing both local and remote files through a unified interface.

Last update: Nov 16, 2022

Overview

cached-path

A file utility library that provides a unified, simple interface for accessing both local and remote files. This can be used behind other APIs that need to access files agnostic to where they are located.

Quick links

Installation

cached-path requires Python 3.6 or later.

Installing with `pip`

cached-path is available on PyPI. Just run

pip install cached-path

Installing from source

To install cached-path from source, first clone the repository:

git clone https://github.com/allenai/cached_path.git
cd cached_path

Then run

pip install -e .

Usage

from cached_path import cached_path

Given something that might be a URL or local path, cached_path() determines which. If it's a remote resource, it downloads the file and caches it to the cache directory, and then returns the path to the cached file. If it's already a local path, it makes sure the file exists and returns the path.

For URLs, http://, https://, s3:// (AWS S3), gs:// (Google Cloud Storage), and hf:// (HuggingFace Hub) are all supported out-of-the-box.

For example, to download the PyTorch weights for the model epwalsh/bert-xsmall-dummy on HuggingFace, you could do:

cached_path("hf://epwalsh/bert-xsmall-dummy/pytorch_model.bin")

For paths or URLs that point to a tarfile or zipfile, you can also add a path to a specific file to the url_or_filename preceeded by a "!", and the archive will be automatically extracted (provided you set extract_archive to True), returning the local path to the specific file. For example:

cached_path("model.tar.gz!weights.th", extract_archive=True)

Cache directory

By default the cache directory is ~/.cache/cached_path/, however there are several ways to override this setting:

set the environment variable CACHED_PATH_CACHE_ROOT,
call set_cache_dir(), or
set the cache_dir argument each time you call cached_path().

Team

cached-path is developed and maintained by the AllenNLP team, backed by the Allen Institute for Artificial Intelligence (AI2). AI2 is a non-profit institute with the mission to contribute to humanity through high-impact AI research and engineering. To learn more about who specifically contributed to this codebase, see our contributors page.

License

cached-path is licensed under Apache 2.0. A full copy of the license can be found on GitHub.

Comments

Switch to `rich` for progress

This is an experimental PR to get away from tqdm and start using rich for everything. Rich does a good job of automatically logging in a file-friendly way when it detects it's running in a non-interactive session. The behavior can also easily be customized by users by configuring rich's default Console. So I don't think there's any need to have our own FILE_FRIENDLY_LOGGING logic here. Hence that stuff has been removed.

We're already using rich for logging / pretty printing in tango and for progress bars in beaker-py. Might as well commit to rich and get rid of Tqdm across our ecosystems, in my opinion. So if ya'll agree with that, we can port this over to Tango as well and get rid out tango.common.tqdm.

opened by epwalsh 6
required version of google-cloud-storage needs bumping
Checklist

[ ] I have verified that the issue exists against the main branch.

[ ] I have read the relevant section in the contribution guide on reporting bugs.

[x] I have checked the issues list for similar or identical bug reports.

[x] I have checked the pull requests list for existing proposed fixes.

[ ] I have checked the CHANGELOG and the commit log to find out if the bug was already fixed in the main branch.

[x] I have included in the "Description" section below a traceback from any exceptions related to this bug.

[x] I have included in the "Related issues or possible duplicates" section beloew all related issues and possible duplicate issues (If there are none, check this box anyway).

[x] I have included in the "Environment" section below the name of the operating system and Python version that I was using when I discovered this bug.

[ ] I have included in the "Environment" section below the output of pip freeze.

[ ] I have included in the "Steps to reproduce" section below a minimally reproducible example.

Description

I already had google-cloud-storage Version: 1.31.0 installed when I installed cached_path, which satisfies the requirements google-cloud-storage>=1.0,<3.0 in https://github.com/allenai/cached_path/blob/main/requirements.txt

However, when I try to import cached_path I get the exception below because that version of google-cloud-storage is out of date: `No module named 'google.cloud.storage.retry'.

I don't know what version of google-cloud-storage added this, but if I do pip install -U google-cloud-storage the error goes away.

Python traceback:

File "/Users/wmoore/Desktop/ZARR/ome-zarr-py/ome_zarr/reader.py", line 7, in <module> from cached_path import cached_path File "/Users/wmoore/opt/anaconda3/envs/omeroweb/lib/python3.9/site-packages/cached_path/__init__.py", line 13, in <module> from ._cached_path import cached_path File "/Users/wmoore/opt/anaconda3/envs/omeroweb/lib/python3.9/site-packages/cached_path/_cached_path.py", line 15, in <module> from .schemes import get_scheme_client, get_supported_schemes, hf_get_from_cache File "/Users/wmoore/opt/anaconda3/envs/omeroweb/lib/python3.9/site-packages/cached_path/schemes/__init__.py", line 3, in <module> from cached_path.schemes.gs import GsClient File "/Users/wmoore/opt/anaconda3/envs/omeroweb/lib/python3.9/site-packages/cached_path/schemes/gs.py", line 11, in <module> from google.cloud.storage.retry import DEFAULT_RETRY ModuleNotFoundError: No module named 'google.cloud.storage.retry'

Related issues or possible duplicates

None

Environment

OS: M1 Mac

Python version: 3.9.12

Output of pip freeze:

$ pip show google-cloud-storage Name: google-cloud-storage Version: 1.31.0 Summary: Google Cloud Storage API client library Home-page: https://github.com/googleapis/python-storage Author: Google LLC Author-email: [email protected] License: Apache 2.0 Location: /Users/wmoore/opt/anaconda3/envs/omeroweb/lib/python3.9/site-packages Requires: google-auth, google-cloud-core, google-resumable-media Required-by: cached-path

Steps to reproduce

Example source:

bug
opened by will-moore 3
Bump isort from 5.10.1 to 5.11.3
Bumps isort from 5.10.1 to 5.11.3.

Release notes

Sourced from isort's releases.

5.11.3

Changes

Renable portray (#2043) @timothycrosley

chore(ci): add minimum GitHub token permissions for workflows (#1969) @varunsh-coder

:beetle: Fixes

Fix packaging pypoetry (#2042) @staticdev

Fix settings for py3.11 (#2040) @staticdev

:construction_worker: Continuous Integration

General CI improvements (#2041) @staticdev

Add release workflow (#2026) @staticdev

v5.11.3

Changes

Renable portray (#2043) @timothycrosley

chore(ci): add minimum GitHub token permissions for workflows (#1969) @varunsh-coder

:beetle: Fixes

Fix packaging pypoetry (#2042) @staticdev

Fix settings for py3.11 (#2040) @staticdev

:construction_worker: Continuous Integration

General CI improvements (#2041) @staticdev

Add release workflow (#2026) @staticdev

5.11.2

Changes

Hotfix for --version. (#2035) @felixxm

5.11.1

Changes December 12 2022

:beetle: Fixes

Only call colorama.init if colorama is available (#2032) @tomaarsen

5.11.0

Changes December 12 2022

Add support to Python 3.11 support (#2024) @staticdev

Remove support to Python 3.6 (#2020) @barrelful

Remove restriction to Python <4.0 (#1878) @staticdev

... (truncated)

Changelog

Sourced from isort's changelog.

5.11.3 December 16 2022

Fixed #2007: settings for py3.11 (#2040) @staticdev

Fixed #2038: packaging pypoetry (#2042) @staticdev

Docs: renable portray (#2043) @timothycrosley

Ci: add minimum GitHub token permissions for workflows (#1969) @varunsh-coder

Ci: general CI improvements (#2041) @staticdev

Ci: add release workflow (#2026) @staticdev

5.11.2 December 12 2022

Hotfix #2034: isort --version is not accurate on 5.11.x releases (#2034) @gschaffner

5.11.1 December 12 2022

Hotfix #2031: only call colorama.init if colorama is available (#2032) @tomaarsen

5.11.0 December 12 2022

Added official support for Python 3.11 (#1996, #2008, #2011) @staticdev

Dropped support for Python 3.6 (#2019) @barrelful

Fixed problematic tests (#2021, #2022) @staticdev

Fixed #1960: Rich compatibility (#1961) @ofek

Fixed #1945, #1986: Python 4.0 upper bound dependency resolving issues @staticdev

Fixed Pyodide CDN URL (#1991) @andersk

Docs: clarify description of use_parentheses (#1941) @mgedmin

Fixed #1976: black compatibility for .pyi files @XuehaiPan

Implemented #1683: magic trailing comma option (#1876) @legau

Add missing space in unrecoverable exception message (#1933) @andersk

Fixed #1895: skip-gitignore: use allow list, not deny list @bmalehorn

Fixed #1917: infinite loop for unmatched parenthesis (#1919) @anirudnits

Docs: shared profiles (#1896) @matthewhughes934

Fixed build-backend values in the example plugins (#1892) @mgorny

Remove reference to jamescurtin/isort-action (#1885) @AndrewLane

Split long cython import lines (#1931) @davidcollins001

Update plone profile: copy of black, plus three settings. (#1926) @mauritsvanrees

Fixed #1815, #1862: Add a command-line flag to sort all re-exports (#1863) @parafoxia

Fixed #1854: lines_before_imports appending lines after comments (#1861) @legau

Remove redundant multi_line_output = 3 from "Compatibility with black" (#1858) @jdufresne

Add tox config example (#1856) @umonaca

Docs: add examples for frozenset and tuple settings (#1822) @sgaist

Docs: add multiple config documentation (#1850) @anirudnits

Commits

6c83bcc Merge pull request #2051 from PyCQA/version/bump-5.11.3

8f63f75 Add missing versions

09de59d Bump version 5.11.3

ee54f83 Merge pull request #2050 from PyCQA/version/bump-5.11.3

1e33d78 Revert set-output changes

0d960cb Merge pull request #2049 from PyCQA/version/bump-5.11.3

21d7a02 Revert version

5a25261 Merge pull request #2048 from PyCQA/version/bump-5.11.3

b01883b Bump version 5.11.3

d3da1cb Merge pull request #2047 from PyCQA/bugfix/packaging-pypoetry

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies
opened by dependabot[bot] 1
Bump isort from 5.10.1 to 5.11.2
Bumps isort from 5.10.1 to 5.11.2.

Release notes

Sourced from isort's releases.

5.11.2

Changes

Hotfix for --version. (#2035) @felixxm

5.11.1

Changes December 12 2022

:beetle: Fixes

Only call colorama.init if colorama is available (#2032) @tomaarsen

5.11.0

Changes December 12 2022

Add support to Python 3.11 support (#2024) @staticdev

Remove support to Python 3.6 (#2020) @barrelful

Remove restriction to Python <4.0 (#1878) @staticdev

Remove language_version for pre-commit hook (#1987) @rafrafek

Add GH release helpers (#2023) @staticdev

Fix integration tests (#2022) @staticdev

Fix unit tests (#2021) @staticdev

Fix Rich compatibility (#1961) @ofek

Fix Pyodide CDN URL (#1991) @andersk

Clarify description of use_parentheses (#1941) @mgedmin

Fix black compatibility for .pyi type stub files (#2017) @XuehaiPan

Add magic trailing comma option (#1876) @legau

Add missing space in unrecoverable exception message (#1933) @andersk

skip-gitignore: use allow list, not deny list (#1900) @bmalehorn

Infinite loop for unmatched parenthesis (#1919) @anirudnits

Document shared profiles (#1896) @matthewhughes934

Fix build-backend values in the example plugins (#1892) @mgorny

Remove reference to jamescurtin/isort-action (#1885) @AndrewLane

Split long cython import lines (#1931) @davidcollins001

Update plone profile: copy of black, plus three settings. (#1926) @mauritsvanrees

Add a command-line flag to sort all re-exports (#1862) (#1863) @parafoxia

Fix lines_before_imports appending lines after comments (#1861) @legau

Remove redundant multi_line_output = 3 from "Compatibility with black" (#1858) @jdufresne

Add tox config example (#1856) @umonaca

doc: Add examples for frozenset and tuple settings (#1822) @sgaist

Add multiple config documentation (#1850) @anirudnits

:construction_worker: Continuous Integration

Pin versions on workflows (#2025) @staticdev

:package: Dependencies

Bump certifi from 2021.10.8 to 2022.12.7 (#2018) @dependabot

Bump ipython from 7.16.2 to 7.16.3 (#1886) @dependabot

Changelog

Sourced from isort's changelog.

5.11.2 December 12 2022

Hotfix #2034: isort --version is not accurate on 5.11.x releases (#2034) @gschaffner

5.11.1 December 12 2022

Hotfix #2031: only call colorama.init if colorama is available (#2032) @tomaarsen

5.11.0 December 12 2022

Added official support for Python 3.11 (#1996, #2008, #2011) @staticdev

Dropped support for Python 3.6 (#2019) @barrelful

Fixed problematic tests (#2021, #2022) @staticdev

Fixed #1960: Rich compatibility (#1961) @ofek

Fixed #1945, #1986: Python 4.0 upper bound dependency resolving issues @staticdev

Fixed Pyodide CDN URL (#1991) @andersk

Docs: clarify description of use_parentheses (#1941) @mgedmin

Fixed #1976: black compatibility for .pyi files @XuehaiPan

Implemented #1683: magic trailing comma option (#1876) @legau

Add missing space in unrecoverable exception message (#1933) @andersk

Fixed #1895: skip-gitignore: use allow list, not deny list @bmalehorn

Fixed #1917: infinite loop for unmatched parenthesis (#1919) @anirudnits

Docs: shared profiles (#1896) @matthewhughes934

Fixed build-backend values in the example plugins (#1892) @mgorny

Remove reference to jamescurtin/isort-action (#1885) @AndrewLane

Split long cython import lines (#1931) @davidcollins001

Update plone profile: copy of black, plus three settings. (#1926) @mauritsvanrees

Fixed #1815, #1862: Add a command-line flag to sort all re-exports (#1863) @parafoxia

Fixed #1854: lines_before_imports appending lines after comments (#1861) @legau

Remove redundant multi_line_output = 3 from "Compatibility with black" (#1858) @jdufresne

Add tox config example (#1856) @umonaca

Docs: add examples for frozenset and tuple settings (#1822) @sgaist

Docs: add multiple config documentation (#1850) @anirudnits

Commits

7eaab8c Merge pull request #2036 from PyCQA/feature/5.11.2-version-bump

112eb30 Update version to 5.11.2

e64306d Merge pull request #2035 from felixxm/version-bump

b418718 Bump version to 5.11.1.

f8146c5 Merge pull request #2033 from PyCQA/hotfix/5.11.1

dd01cfe Hotfix 5.11.1

68f0a25 Merge pull request #2032 from tomaarsen/hotfix/colorama_nameerror

c752a6c Only call colorama.init if colorama is available

6525008 Merge pull request #2030 from PyCQA/example/update-formatting-pluging-isort-5...

6c5a36c Bump formatting plugin to 0.1.1

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies
opened by dependabot[bot] 1
Bump isort from 5.10.1 to 5.11.1
Bumps isort from 5.10.1 to 5.11.1.

Release notes

Sourced from isort's releases.

5.11.1

Changes December 12 2022

:beetle: Fixes

Only call colorama.init if colorama is available (#2032) @tomaarsen

5.11.0

Changes December 12 2022

Add support to Python 3.11 support (#2024) @staticdev

Remove support to Python 3.6 (#2020) @barrelful

Remove restriction to Python <4.0 (#1878) @staticdev

Remove language_version for pre-commit hook (#1987) @rafrafek

Add GH release helpers (#2023) @staticdev

Fix integration tests (#2022) @staticdev

Fix unit tests (#2021) @staticdev

Fix Rich compatibility (#1961) @ofek

Fix Pyodide CDN URL (#1991) @andersk

Clarify description of use_parentheses (#1941) @mgedmin

Fix black compatibility for .pyi type stub files (#2017) @XuehaiPan

Add magic trailing comma option (#1876) @legau

Add missing space in unrecoverable exception message (#1933) @andersk

skip-gitignore: use allow list, not deny list (#1900) @bmalehorn

Infinite loop for unmatched parenthesis (#1919) @anirudnits

Document shared profiles (#1896) @matthewhughes934

Fix build-backend values in the example plugins (#1892) @mgorny

Remove reference to jamescurtin/isort-action (#1885) @AndrewLane

Split long cython import lines (#1931) @davidcollins001

Update plone profile: copy of black, plus three settings. (#1926) @mauritsvanrees

Add a command-line flag to sort all re-exports (#1862) (#1863) @parafoxia

Fix lines_before_imports appending lines after comments (#1861) @legau

Remove redundant multi_line_output = 3 from "Compatibility with black" (#1858) @jdufresne

Add tox config example (#1856) @umonaca

doc: Add examples for frozenset and tuple settings (#1822) @sgaist

Add multiple config documentation (#1850) @anirudnits

:construction_worker: Continuous Integration

Pin versions on workflows (#2025) @staticdev

:package: Dependencies

Bump certifi from 2021.10.8 to 2022.12.7 (#2018) @dependabot

Bump ipython from 7.16.2 to 7.16.3 (#1886) @dependabot

Changelog

Sourced from isort's changelog.

5.11.1 December 12 2022

Hotfix #2031: only call colorama.init if colorama is available (#2032) @tomaarsen

5.11.0 December 12 2022

Added official support for Python 3.11 (#1996, #2008, #2011) @staticdev

Dropped support for Python 3.6 (#2019) @barrelful

Fixed problematic tests (#2021, #2022) @staticdev

Fixed #1960: Rich compatibility (#1961) @ofek

Fixed #1945, #1986: Python 4.0 upper bound dependency resolving issues @staticdev

Fixed Pyodide CDN URL (#1991) @andersk

Docs: clarify description of use_parentheses (#1941) @mgedmin

Fixed #1976: black compatibility for .pyi files @XuehaiPan

Implemented #1683: magic trailing comma option (#1876) @legau

Add missing space in unrecoverable exception message (#1933) @andersk

Fixed #1895: skip-gitignore: use allow list, not deny list @bmalehorn

Fixed #1917: infinite loop for unmatched parenthesis (#1919) @anirudnits

Docs: shared profiles (#1896) @matthewhughes934

Fixed build-backend values in the example plugins (#1892) @mgorny

Remove reference to jamescurtin/isort-action (#1885) @AndrewLane

Split long cython import lines (#1931) @davidcollins001

Update plone profile: copy of black, plus three settings. (#1926) @mauritsvanrees

Fixed #1815, #1862: Add a command-line flag to sort all re-exports (#1863) @parafoxia

Fixed #1854: lines_before_imports appending lines after comments (#1861) @legau

Remove redundant multi_line_output = 3 from "Compatibility with black" (#1858) @jdufresne

Add tox config example (#1856) @umonaca

Docs: add examples for frozenset and tuple settings (#1822) @sgaist

Docs: add multiple config documentation (#1850) @anirudnits

Commits

f8146c5 Merge pull request #2033 from PyCQA/hotfix/5.11.1

dd01cfe Hotfix 5.11.1

68f0a25 Merge pull request #2032 from tomaarsen/hotfix/colorama_nameerror

c752a6c Only call colorama.init if colorama is available

6525008 Merge pull request #2030 from PyCQA/example/update-formatting-pluging-isort-5...

6c5a36c Bump formatting plugin to 0.1.1

657ed81 Merge pull request #2029 from PyCQA/example/update-formatting-pluging-isort-5...

84e3687 Update isort on formatting pluging to 5.11.0

3e99c22 Merge pull request #2028 from PyCQA/prepare-release-5.11.0

8af078c Upgrade poetry to 1.3.1

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies
opened by dependabot[bot] 1
Bump mypy from 0.982 to 0.990
Bumps mypy from 0.982 to 0.990.

Commits

b71dc3d Remove +dev from version

719cef9 Add support for exception groups and except* (#14020)

91b6fc3 Fix crash on nested unions in recursive types (#14007)

42a4c69 Make TryStar not crash (#13991)

5fad1ac Warn on invalid *args and **kwargs with ParamSpec (#13892)

184add9 Revert sum literal integer change (#13961)

74e0dff Add hidden options to disable bytes promotion (#13952)

ec6d9d9 [mypyc] Fix ircheck if register is initialized through LoadAddress (#13944)

8ef701d Use 3.11 instead of 3.11-dev (#13945)

ec149da [mypyc] Fix glue methods with native int types (#13939)

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies
opened by dependabot[bot] 1
Bump sphinx from 5.1.1 to 5.2.1
Bumps sphinx from 5.1.1 to 5.2.1.

Release notes

Sourced from sphinx's releases.

v5.2.1

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.2.0

Changelog: https://www.sphinx-doc.org/en/master/changes.html

Changelog

Sourced from sphinx's changelog.

Release 5.2.1 (released Sep 24, 2022)

Bugs fixed

#10861: Always normalise the pycon3 lexer to pycon.

Fix using sphinx.ext.autosummary with modules containing titles in the module-level docstring.

Release 5.2.0.post0 (released Sep 24, 2022)

Recreated source tarballs for Debian maintainers.

Release 5.2.0 (released Sep 24, 2022)

Dependencies

#10356: Sphinx now uses declarative metadata with pyproject.toml to create packages, using PyPA's flit project as a build backend. Patch by Adam Turner.

Deprecated

#10843: Support for HTML 4 output. Patch by Adam Turner.

Features added

#10738: napoleon: Add support for docstring types using 'of', like type of type. Example: tuple of int.

#10286: C++, support requires clauses not just between the template parameter lists and the declaration.

#10755: linkcheck: Check the source URL of raw directives that use the url option.

#10781: Allow :rst:role:ref role to be used with definitions and fields.

#10717: HTML Search: Increase priority for full title and subtitle matches in search results

#10718: HTML Search: Save search result score to the HTML element for debugging

#10673: Make toctree accept 'genindex', 'modindex' and 'search' docnames

#6316, #10804: Add domain objects to the table of contents. Patch by Adam Turner

#6692: HTML Search: Include explicit :rst:dir:index directive index entries in the search index and search results. Patch by Adam Turner

#10816: imgmath: Allow embedding images in HTML as base64

#10854: HTML Search: Use browser localstorage for highlight control, stop storing highlight parameters in URL query strings. Patch by Adam Turner.

... (truncated)

Commits

e0dbbc5 Bump to 5.2.1 final

15c1cba Fix error in changelog for Sphinx 5.2.0

77cee67 Define extra indent as a class attribute

9ced736 Fix highlighting lexers

cd24c54 Bump to 5.2.0.post0 final

911a5fe Bump to 5.2.0 final

bc59a1d Merge 5.1.2 CHANGES into 5.2.0

2f2bd55 Merge pull request #10859 from jfbu/latex_doc_tableofcontentshook

89a656d LaTeX: improved doc of \sphinxtableofcontents (closes #10858)

6508121 Docstring clarifications (#9877)

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies
opened by dependabot[bot] 1
Bump sphinx from 5.0.2 to 5.1.0
Bumps sphinx from 5.0.2 to 5.1.0.

Release notes

Sourced from sphinx's releases.

v5.1.0

Changelog: https://www.sphinx-doc.org/en/master/changes.html

Changelog

Sourced from sphinx's changelog.

Release 5.1.0 (released Jul 24, 2022)

Dependencies

#10656: Support Docutils 0.19_. Patch by Adam Turner.

.. _Docutils 0.19: https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-19-2022-07-05

Deprecated

#10467: Deprecated sphinx.util.stemmer in favour of snowballstemmer. Patch by Adam Turner.

#9856: Deprecated sphinx.ext.napoleon.iterators.

Features added

#10444: html theme: Allow specifying multiple CSS files through the stylesheet setting in theme.conf or by setting html_style to an iterable of strings.

#10366: std domain: Add support for emphasising placeholders in :rst:dir:option directives through a new :confval:option_emphasise_placeholders configuration option.

#10439: std domain: Use the repr of some variables when displaying warnings, making whitespace issues easier to identify.

#10571: quickstart: Reduce content in the generated conf.py file. Patch by Pradyun Gedam.

#10648: LaTeX: CSS-named-alike additional :ref:'sphinxsetup' <latexsphinxsetup> keys allow to configure four separate border-widths, four paddings, four corner radii, a shadow (possibly inset), colours for border, background, shadow for each of the code-block, topic, attention, caution, danger, error and warning directives.

#10655: LaTeX: Explain non-standard encoding in LatinRules.xdy

#10599: HTML Theme: Wrap consecutive footnotes in an <aside> element when using Docutils 0.18 or later, to allow for easier styling. This matches the behaviour introduced in Docutils 0.19. Patch by Adam Turner.

#10518: config: Add include_patterns as the opposite of exclude_patterns. Patch by Adam Turner.

Bugs fixed

#10594: HTML Theme: field term colons are doubled if using Docutils 0.18+

#10596: Build failure if Docutils version is 0.18 (not 0.18.1) due to missing Node.findall()

#10506: LaTeX: build error if highlighting inline code role in figure caption (refs: #10251)

#10634: Make -P (pdb) option work better with exceptions triggered from events

... (truncated)

Commits

cc1f6cb Bump to 5.1.0 final

8effd15 Update message catalogs (#10698)

e3337c7 Update include_patterns implementation (#10680)

89db13d Merge pull request #10676 from AA-Turner/authors

40caf0c Merge pull request #10696 from jfbu/latex_fix_for_old_latex

d1b4a75 LaTeX: fix another incompatibility with old pict2e LaTeX

faccc21 Fix #10695: old LaTeX does not allow @ifpackageloaded usage in body

afac558 Merge branch '5.0.x' into 5.x

94f62e7 Merge pull request #10693 from tk0miya/mypy-0.971

5b89c39 Fix mypy violations (with mypy-0.971)

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies
opened by dependabot[bot] 1
Bump sphinx from 4.5.0 to 5.0.0
Bumps sphinx from 4.5.0 to 5.0.0.

Release notes

Sourced from sphinx's releases.

v5.0.0b1

Changelog: https://www.sphinx-doc.org/en/master/changes.html

Changelog

Sourced from sphinx's changelog.

Release 5.0.0 (released May 30, 2022)

Dependencies

5.0.0 b1

#10164: Support Docutils 0.18_. Patch by Adam Turner.

.. _Docutils 0.18: https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-18-2021-10-26

Incompatible changes

5.0.0 b1

#10031: autosummary: sphinx.ext.autosummary.import_by_name() now raises ImportExceptionGroup instead of ImportError when it failed to import target object. Please handle the exception if your extension uses the function to import Python object. As a workaround, you can disable the behavior via grouped_exception=False keyword argument until v7.0.

#9962: texinfo: Customizing styles of emphasized text via @definfoenclose command was not supported because the command was deprecated since texinfo 6.8

#2068: :confval:intersphinx_disabled_reftypes has changed default value from an empty list to ['std:doc'] as avoid too surprising silent intersphinx resolutions. To migrate: either add an explicit inventory name to the references intersphinx should resolve, or explicitly set the value of this configuration variable to an empty list.

#10197: html theme: Reduce body_min_width setting in basic theme to 360px

#9999: LaTeX: separate terms from their definitions by a CR (refs: #9985)

#10062: Change the default language to 'en' if any language is not set in conf.py

5.0.0 final

#10474: :confval:language does not accept None as it value. The default value of language becomes to 'en' now.

Deprecated

5.0.0 b1

#10028: jQuery and underscore.js will no longer be automatically injected into themes from Sphinx 6.0. If you develop a theme or extension that uses the jQuery, $, or $u global objects, you need to update your JavaScript or use the mitigation below.

... (truncated)

Commits

953002e Bump to 5.0.0 final

3d3e932 Merge pull request #10463 from AA-Turner/fix-css-docutils-0-18

9298b3e Update message catalogs

bdeb627 Merge pull request #10486 from tk0miya/fix_babel_extract_message

16ca323 Fix imgconverter: Failed to extract translation messages

dc30920 Merge pull request #10481 from AA-Turner/lang-none-en

2004149 Update test

78c478a Merge remote-tracking branch 'upstream/5.0.x' into lang-none-en

479e482 Update warning, revert my original warning patch

fb6db30 Update comment

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies
opened by dependabot[bot] 1
Bump responses from 0.20.0 to 0.21.0
Bumps responses from 0.20.0 to 0.21.0.

Release notes

Sourced from responses's releases.

0.21.0

Add threading.Lock() to allow responses working with threading module.

Add urllib3 Retry mechanism. See #135

Removed internal _cookies_from_headers function

Now add, upsert, replace methods return registered response. remove method returns list of removed responses.

Added null value support in urlencoded_params_matcher via allow_blank keyword argument

Added strict version of decorator. Now you can apply @responses.activate(assert_all_requests_are_fired=True) to your function to validate that all requests were executed in the wrapped function. See #183

Changelog

Sourced from responses's changelog.

0.21.0

Add threading.Lock() to allow responses working with threading module.

Add urllib3 Retry mechanism. See #135

Removed internal _cookies_from_headers function

Now add, upsert, replace methods return registered response. remove method returns list of removed responses.

Added null value support in urlencoded_params_matcher via allow_blank keyword argument

Added strict version of decorator. Now you can apply @responses.activate(assert_all_requests_are_fired=True) to your function to validate that all requests were executed in the wrapped function. See #183

Commits

184793a release: 0.21.0

48f2729 fix(ci) Fix lint errors from additional ignores (#553)

ebf6811 Inline types for responses top level API (#537)

04c9e15 Improve documentation (#550)

fa7447f remove setup.cfg (#544)

e820284 fix some examples (#549)

eaa878c added blacken docs pre-commit hook (#543)

df920c0 added inline types to Response objects (#535)

bdc5eff Add urllib3 Retry mechanism, documentation and tests (#536)

4f513fc remove stub files from the package (#538)

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies
opened by dependabot[bot] 1
Update huggingface-hub requirement from <0.6.0,>=0.0.12 to >=0.0.12,<0.7.0
Updates the requirements on huggingface-hub to permit the latest version.

Release notes

Sourced from huggingface-hub's releases.

v0.6.0: fastai support, repocard metadata, binary file support, skip LFS files when pushing to the hub

fastai support

v0.6.0 introduces downstream (download) and upstream (upload) support for the fastai libraries. It supports fastai versions above 2.4. The integration is detailed in the following blog.

Add fastai upstream and downstream capacities for fastai>=2.4 and fastcore>=1.3.27 versions by @omarespejel in #678

Automatic binary file tracking in Repository

Binary files are now rejected by default by the Hub. v0.6.0 introduces automatic binary file tracking through the auto_lfs_track argument of the Repository.git_add method. It also introduces the Repository.auto_track_binary_files method which can be used independently of other methods.

ENH Auto track binary files in Repository by @LysandreJik in #828

skip_lfs_file is now added to mixins

The parameter skip_lfs_files is now added to the different mixins. This will enable pushing files to the hub without first downloading the files above 10MB. This should drammatically reduce the time needed when updating a modelcard, a configuration file, and others.

:sparkles: add skip_lfs_files to mixins' push_to_hub by @nateraw in #858

Repocard metadata

This PR adds a metadata_update function that allows the user to update the metadata in a repository on the hub. The function accepts a dict with metadata (following the same pattern as the YAML in the README) and behaves as follows for all top level fields except model-index.

Examples:

Starting from

existing_results = [{ 'dataset': {'name': 'IMDb', 'type': 'imdb'}, 'metrics': [{'name': 'Accuracy', 'type': 'accuracy', 'value': 0.995}], 'task': {'name': 'Text Classification', 'type': 'text-classification'} }]

1. Overwrite existing metric value in existing result

new_results = deepcopy(existing_results) new_results[0]["metrics"][0]["value"] = 0.999 _update_metadata_model_index(existing_results, new_results, overwrite=True)

[{'dataset': {'name': 'IMDb', 'type': 'imdb'}, 'metrics': [{'name': 'Accuracy', 'type': 'accuracy', 'value': 0.999}], 'task': {'name': 'Text Classification', 'type': 'text-classification'}}]

2. Add new metric to existing result

... (truncated)

Commits

a8b6f14 Release: v0.6.0

26e55c0 RC Release: v0.6.0.rc0

7042df3 Enable keras download stats (#860)

33c0de3 :sparkles: add skip_lfs_files to mixins' push_to_hub (#858)

9a516f5 DOC Update landing page (#854)

627fdb2 Update contribution guide for merging PRs (#856)

dabcc83 Update how to guides (#840)

cab4152 Add fastai upstream and downstream capacities for fastai>=2.4 and fastcore>=1...

04c38fc MNT enable preview on black (#849)

e61f39b MNT refactor: subprocess.run -> run_subprocess (#352)

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies
opened by dependabot[bot] 1
Bump sphinx from 5.3.0 to 6.0.0
Bumps sphinx from 5.3.0 to 6.0.0.

Release notes

Sourced from sphinx's releases.

v6.0.0

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v6.0.0b2

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v6.0.0b1

Changelog: https://www.sphinx-doc.org/en/master/changes.html

Changelog

Sourced from sphinx's changelog.

Release 6.0.0 (released Dec 29, 2022)

Dependencies

#10468: Drop Python 3.6 support

#10470: Drop Python 3.7, Docutils 0.14, Docutils 0.15, Docutils 0.16, and Docutils 0.17 support. Patch by Adam Turner

Incompatible changes

#7405: Removed the jQuery and underscore.js JavaScript frameworks.

These frameworks are no longer be automatically injected into themes from Sphinx 6.0. If you develop a theme or extension that uses the jQuery, $, or $u global objects, you need to update your JavaScript to modern standards, or use the mitigation below.

The first option is to use the sphinxcontrib.jquery_ extension, which has been developed by the Sphinx team and contributors. To use this, add sphinxcontrib.jquery to the extensions list in conf.py, or call app.setup_extension("sphinxcontrib.jquery") if you develop a Sphinx theme or extension.

The second option is to manually ensure that the frameworks are present. To re-add jQuery and underscore.js, you will need to copy jquery.js and underscore.js from the Sphinx repository_ to your static directory, and add the following to your layout.html:

.. code-block:: html+jinja

{%- block scripts %} {{ super() }} {%- endblock %}

.. _sphinxcontrib.jquery: https://github.com/sphinx-contrib/jquery/

Patch by Adam Turner.

#10471, #10565: Removed deprecated APIs scheduled for removal in Sphinx 6.0. See :ref:dev-deprecated-apis for details. Patch by Adam Turner.

#10901: C Domain: Remove support for parsing pre-v3 style type directives and roles. Also remove associated configuration variables c_allow_pre_v3 and c_warn_on_allowed_pre_v3. Patch by Adam Turner.

Features added

... (truncated)

Commits

5b56a23 Bump to 6.0.0 final

f1d1e9c Update coverage workflow for Tox 4

66a738c Update coverage workflow for new configuration location

041e5f8 Add test coverage for 'today_fmt' reference substitution (#10980)

da25145 Remove unnecessary conditional import in sphinx.ext.napoleon (#11043)

45a0ea9 Migrate coveragepy config into pyproject.toml (#11025)

3ec54f1 Create a pydata_sphinx_theme section in usage examples (#11046)

32bce8f Copy edit the tutorial (#11049)

9844162 Fix example using add_config_value (#10937)

bf4a626 RTD builder: add graphviz depedendency (#11040)

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies
opened by dependabot[bot] 0
Update rich requirement from <13.0,>=12.1 to >=12.1,<14.0
Updates the requirements on rich to permit the latest version.

Release notes

Sourced from rich's releases.

Dropped Python3.6 support

Some relatively minor fixes and improvements. The most significant update (and the reason for the major version bump) is that Rich has dropped Python3.6 support.

If you are a Python3.6 user and can't upgrade for whatever reason, pin to version 12.6.0.

[13.0.0] - 2022-12-30

Fixed

Reversed pre and code tags in base HTML format Textualize/rich#2642

Improved detection of attrs library, that isn't confused by the presence of the attr library.

Fixed issue with locals_max_length parameter not being respected in Traceback Textualize/rich#2649

Handling of broken fileno made more robust. Fixes Textualize/rich#2645

Fixed missing fileno on FileProxy

Changed

Bumped minimum Python version to 3.7 Textualize/rich#2567

Pretty-printing of "tagged" __repr__ results is now greedy when matching tags Textualize/rich#2565

progress.track now supports deriving total from __length_hint__

Added

Add type annotation for key_separator of pretty.Node Textualize/rich#2625

Changelog

Sourced from rich's changelog.

[13.0.0] - 2022-12-30

Fixed

Reversed pre and code tags in base HTML format Textualize/rich#2642

Improved detection of attrs library, that isn't confused by the presence of the attr library.

Fixed issue with locals_max_length parameter not being respected in Traceback Textualize/rich#2649

Handling of broken fileno made more robust. Fixes Textualize/rich#2645

Fixed missing fileno on FileProxy

Changed

Bumped minimum Python version to 3.7 Textualize/rich#2567

Pretty-printing of "tagged" __repr__ results is now greedy when matching tags Textualize/rich#2565

progress.track now supports deriving total from __length_hint__

Added

Add type annotation for key_separator of pretty.Node Textualize/rich#2625

[12.6.0] - 2022-10-02

Added

Parse ANSI escape sequences in pretty repr Textualize/rich#2470

Add support for FORCE_COLOR env var Textualize/rich#2449

Allow a max_depth argument to be passed to the install() hook Textualize/rich#2486

Document using None as name in __rich_repr__ for tuple positional args Textualize/rich#2379

Add font_aspect_ratio parameter in SVG export Textualize/rich#2539

Added Table.add_section method. Textualize/rich#2544

Fixed

Handle stdout/stderr being null Textualize/rich#2513

Fix NO_COLOR support on legacy Windows Textualize/rich#2458

Fix pretty printer handling of cyclic references Textualize/rich#2524

Fix missing mode property on file wrapper breaking uploads via requests Textualize/rich#2495

Fix mismatching default value of parameter ensure_ascii Textualize/rich#2538

Remove unused height parameter in Layout class Textualize/rich#2540

Fixed exception in Syntax.rich_measure for empty files

Changed

Removed border from code blocks in Markdown

[12.5.2] - 2022-07-18

Added

... (truncated)

Commits

d14b304 Merge pull request #2727 from Textualize/v13.0.0

7cf0797 changelog

245c737 release in changelog

b2fa5f1 changelog

7601290 Merge pull request #2715 from Textualize/win-batch

e833da9 don't reraise

b66f1f0 comment

c8c116c fix typing

1f3f18c try new poetry

497177f better batching

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies
opened by dependabot[bot] 0
Update filelock requirement from <3.9,>=3.4 to >=3.4,<3.10
Updates the requirements on filelock to permit the latest version.

Release notes

Sourced from filelock's releases.

3.9.0

What's Changed

Move to hatchling build backend by @gaborbernat in tox-dev/py-filelock#185

Full Changelog: https://github.com/tox-dev/py-filelock/compare/3.8.2...3.9.0

Changelog

Sourced from filelock's changelog.

v3.9.0 (2022-12-28)

Move build backend to hatchling :pr:185 - by :user:gaborbernat`.

v3.8.1 (2022-12-04)

Fix mypy does not accept filelock.FileLock as a valid type

v3.8.0 (2022-12-04)

Bump project dependencies

Add timeout unit to docstrings

Support 3.11

v3.7.1 (2022-05-31)

Make the readme documentation point to the index page

v3.7.0 (2022-05-13)

Add ability to return immediately when a lock cannot be obtained

v3.6.0 (2022-02-17)

Fix pylint warning "Abstract class :class:WindowsFileLock <filelock.WindowsFileLock> with abstract methods instantiated" :pr:135 - by :user:vonschultz

Fix pylint warning "Abstract class :class:UnixFileLock <filelock.UnixFileLock> with abstract methods instantiated" :pr:135 - by :user:vonschultz

v3.5.1 (2022-02-16)

Use time.monotonic instead of time.time for calculating timeouts.

v3.5.0 (2022-02-15)

Enable use as context decorator

v3.4.2 (2021-12-16)

Drop support for python 3.6

v3.4.1 (2021-12-16)

Add stacklevel to deprecation warnings for argument name change

v3.4.0 (2021-11-16)

Add correct spelling of poll interval parameter for :meth:acquire <filelock.BaseFileLock.acquire> method, raise deprecation warning when using the misspelled form :pr:119 - by :user:XuehaiPan.

... (truncated)

Commits

1cf8fca Fix the CI, bump tools (#185)

fed33ae Delete codecov.yml

be102db Update setup.cfg

506b6b1 [pre-commit.ci] pre-commit autoupdate (#183)

21c5d0f [pre-commit.ci] pre-commit autoupdate (#182)

b74898a Bump pypa/gh-action-pypi-publish from 1.6.1 to 1.6.4 (#181)

b8b6f2b Update the license classifier to "Unlicense" (#180)

331c7a4 Bump pypa/gh-action-pypi-publish from 1.5.1 to 1.6.1 (#178)

579ccc3 Fix mypy fails understanding FileLock (#177)

b693fe1 fix BaseFileLock.timeout's getter/setter being obscured by itself (#172)

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies
opened by dependabot[bot] 0
Bump isort from 5.10.1 to 5.11.4
Bumps isort from 5.10.1 to 5.11.4.

Release notes

Sourced from isort's releases.

5.11.4

Changes

Remove obsolete toml import from the test suite (#1978) @mgorny

Stop installing documentation files to top-level site-packages (#2057) @mgorny

Only run release workflows for upstream (#2052) @hugovk

:package: Dependencies

Bump Poetry 1.3.1 (#2058) @staticdev

5.11.3

Changes

Renable portray (#2043) @timothycrosley

chore(ci): add minimum GitHub token permissions for workflows (#1969) @varunsh-coder

:beetle: Fixes

Fix packaging pypoetry (#2042) @staticdev

Fix settings for py3.11 (#2040) @staticdev

:construction_worker: Continuous Integration

General CI improvements (#2041) @staticdev

Add release workflow (#2026) @staticdev

v5.11.3

Changes

Renable portray (#2043) @timothycrosley

chore(ci): add minimum GitHub token permissions for workflows (#1969) @varunsh-coder

:beetle: Fixes

Fix packaging pypoetry (#2042) @staticdev

Fix settings for py3.11 (#2040) @staticdev

:construction_worker: Continuous Integration

General CI improvements (#2041) @staticdev

Add release workflow (#2026) @staticdev

5.11.2

Changes

Hotfix for --version. (#2035) @felixxm

5.11.1

Changes December 12 2022

... (truncated)

Changelog

Sourced from isort's changelog.

5.11.4 December 21 2022

Fixed #2038 (again): stop installing documentation files to top-level site-packages (#2057) @mgorny

CI: only run release workflows for upstream (#2052) @hugovk

Tests: remove obsolete toml import from the test suite (#1978) @mgorny

CI: bump Poetry 1.3.1 (#2058) @staticdev

5.11.3 December 16 2022

Fixed #2007: settings for py3.11 (#2040) @staticdev

Fixed #2038: packaging pypoetry (#2042) @staticdev

Docs: renable portray (#2043) @timothycrosley

Ci: add minimum GitHub token permissions for workflows (#1969) @varunsh-coder

Ci: general CI improvements (#2041) @staticdev

Ci: add release workflow (#2026) @staticdev

5.11.2 December 12 2022

Hotfix #2034: isort --version is not accurate on 5.11.x releases (#2034) @gschaffner

5.11.1 December 12 2022

Hotfix #2031: only call colorama.init if colorama is available (#2032) @tomaarsen

5.11.0 December 12 2022

Added official support for Python 3.11 (#1996, #2008, #2011) @staticdev

Dropped support for Python 3.6 (#2019) @barrelful

Fixed problematic tests (#2021, #2022) @staticdev

Fixed #1960: Rich compatibility (#1961) @ofek

Fixed #1945, #1986: Python 4.0 upper bound dependency resolving issues @staticdev

Fixed Pyodide CDN URL (#1991) @andersk

Docs: clarify description of use_parentheses (#1941) @mgedmin

Fixed #1976: black compatibility for .pyi files @XuehaiPan

Implemented #1683: magic trailing comma option (#1876) @legau

Add missing space in unrecoverable exception message (#1933) @andersk

Fixed #1895: skip-gitignore: use allow list, not deny list @bmalehorn

Fixed #1917: infinite loop for unmatched parenthesis (#1919) @anirudnits

Docs: shared profiles (#1896) @matthewhughes934

Fixed build-backend values in the example plugins (#1892) @mgorny

Remove reference to jamescurtin/isort-action (#1885) @AndrewLane

Split long cython import lines (#1931) @davidcollins001

Update plone profile: copy of black, plus three settings. (#1926) @mauritsvanrees

Fixed #1815, #1862: Add a command-line flag to sort all re-exports (#1863) @parafoxia

Fixed #1854: lines_before_imports appending lines after comments (#1861) @legau

Remove redundant multi_line_output = 3 from "Compatibility with black" (#1858) @jdufresne

Add tox config example (#1856) @umonaca

Docs: add examples for frozenset and tuple settings (#1822) @sgaist

Docs: add multiple config documentation (#1850) @anirudnits

Commits

98390f5 Merge pull request #2059 from PyCQA/version/5.11.4

df69a05 Bump version 5.11.4

f9add58 Merge pull request #2058 from PyCQA/deps/poetry-1.3.1

36caa91 Bump Poetry 1.3.1

3c2e2d0 Merge pull request #1978 from mgorny/toml-test

45d6abd Remove obsolete toml import from the test suite

3020e0b Merge pull request #2057 from mgorny/poetry-install

a6fdbfd Stop installing documentation files to top-level site-packages

ff306f8 Fix tag template to match old standard

227c4ae Merge pull request #2052 from hugovk/main

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies
opened by dependabot[bot] 0
Bump black from 22.10.0 to 22.12.0
Bumps black from 22.10.0 to 22.12.0.

Release notes

Sourced from black's releases.

22.12.0

Preview style

Enforce empty lines before classes and functions with sticky leading comments (#3302)

Reformat empty and whitespace-only files as either an empty file (if no newline is present) or as a single newline character (if a newline is present) (#3348)

Implicitly concatenated strings used as function args are now wrapped inside parentheses (#3307)

Correctly handle trailing commas that are inside a line's leading non-nested parens (#3370)

Configuration

Fix incorrectly applied .gitignore rules by considering the .gitignore location and the relative path to the target file (#3338)

Fix incorrectly ignoring .gitignore presence when more than one source directory is specified (#3336)

Parser

Parsing support has been added for walruses inside generator expression that are passed as function args (for example, any(match := my_re.match(text) for text in texts)) (#3327).

Integrations

Vim plugin: Optionally allow using the system installation of Black via let g:black_use_virtualenv = 0(#3309)

Changelog

Sourced from black's changelog.

22.12.0

Preview style

Enforce empty lines before classes and functions with sticky leading comments (#3302)

Reformat empty and whitespace-only files as either an empty file (if no newline is present) or as a single newline character (if a newline is present) (#3348)

Implicitly concatenated strings used as function args are now wrapped inside parentheses (#3307)

Correctly handle trailing commas that are inside a line's leading non-nested parens (#3370)

Configuration

Fix incorrectly applied .gitignore rules by considering the .gitignore location and the relative path to the target file (#3338)

Fix incorrectly ignoring .gitignore presence when more than one source directory is specified (#3336)

Parser

Parsing support has been added for walruses inside generator expression that are passed as function args (for example, any(match := my_re.match(text) for text in texts)) (#3327).

Integrations

Vim plugin: Optionally allow using the system installation of Black via let g:black_use_virtualenv = 0(#3309)

Commits

2ddea29 Prepare release 22.12.0 (#3413)

5b1443a release: skip bad macos wheels for now (#3411)

9ace064 Bump peter-evans/find-comment from 2.0.1 to 2.1.0 (#3404)

19c5fe4 Fix CI with latest flake8-bugbear (#3412)

d4a8564 Bump sphinx-copybutton from 0.5.0 to 0.5.1 in /docs (#3390)

2793249 Wordsmith current_style.md (#3383)

d97b789 Remove whitespaces of whitespace-only files (#3348)

c23a5c1 Clarify that Black runs with --safe by default (#3378)

8091b25 Correctly handle trailing commas that are inside a line's leading non-nested ...

ffaaf48 Compare each .gitignore found with an appropiate relative path (#3338)

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies
opened by dependabot[bot] 0
Bump furo from 2022.9.29 to 2022.12.7
Bumps furo from 2022.9.29 to 2022.12.7.

Changelog

Sourced from furo's changelog.

Changelog

2022.12.07 -- Reverent Raspberry

✨ Add support for Sphinx 6.

✨ Improve footnote presentation with docutils 0.18+.

Drop support for Sphinx 4.

Improve documentation about what the edit button does.

Improve handling of empty-flexboxes for better print experience on Chrome.

Improve styling for inline signatures.

Replace the meta generator tag with a comment.

Tweak labels with icons to prevent users selecting icons as text on touch.

2022.09.29 -- Quaint Quartz

Add ability to set arbitrary URLs for edit button.

Add support for aligning text in MyST-parser generated tables.

2022.09.15 -- Pragmatic Pistachio

Add a minimum version constraint on pygments.

Add an explicit dependency on sass.

Change right sidebar title from "Contents" to "On this page".

Correctly position sidebars on small screens.

Correctly select only Furo's own svg in related pages nav.

Make numpy-style documentation headers consistent.

Retitle the reference section.

Update npm dependencies.

2022.06.21 -- Opulent Opal

Fix docutils <= 0.17.x compatibility.

Bump to the latest Node.js LTS.

2022.06.04.1 -- Naughty Nickel bugfix

Fix the URL used in the "Edit this page" for Read the Docs builds.

2022.06.04 -- Naughty Nickel

... (truncated)

Commits

1034267 Prepare release: 2022.12.07

239e69f Update changelog

8faac34 Remove the no-longer-useful gh-pages workflow

faa27fb Fix the hyperlink warning

9849ec0 Forward the arguments to stb serve

e0dc9b8 [pre-commit.ci] pre-commit autoupdate (#588)

9842e25 Clarify what the edit button does (#587)

0d2cf0b [pre-commit.ci] pre-commit autoupdate (#578)

b7d8866 Revert "Document that GCC is using Furo! (#575)" (#577)

0ab12bb Improve footnote presentation with docutils 0.18+ (#576)

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies
opened by dependabot[bot] 0

Releases(v1.1.6)

v1.1.6(Sep 28, 2022)
What's new

Changed ⚠️

When we're exceeding the maximum number of retries, the exception object now contains a string message instead of the last unsuccessful request object.

Commits

3de3b22 Merge pull request #93 from allenai/dependabot/pip/responses-0.21.0 8f4cb21 Merge pull request #113 from allenai/dependabot/pip/black-22.8.0 0d7d6e7 Merge pull request #114 from allenai/dependabot/pip/furo-2022.9.15 1e46bae Merge pull request #116 from allenai/dependabot/pip/mypy-0.981 832e267 Merge pull request #117 from allenai/dependabot/pip/myst-parser-0.18.1 f981f18 Merge pull request #119 from allenai/dependabot/pip/sphinx-5.2.2 35addf9 Merge pull request #118 from allenai/dependabot/pip/huggingface-hub-gte-0.8.1-and-lt-0.11.0 afeab81 Update huggingface-hub requirement (#112) 20e311f Update filelock requirement from <3.8,>=3.4 to >=3.4,<3.9 (#111) 27a3469 Bump sphinx from 5.0.2 to 5.1.1 (#110) 0897643 Bump mypy from 0.961 to 0.971 (#108)
Source code(tar.gz)
Source code(zip)
cached_path-1.1.6-py3-none-any.whl(25.94 KB)
cached_path-1.1.6.tar.gz(22.65 KB)
v1.1.5(Jul 6, 2022)

What's new

Commits

bb20b04 Pin google-cloud-storage to at least 1.32.0 (#107)
Source code(tar.gz)
Source code(zip)
cached_path-1.1.5-py3-none-any.whl(25.89 KB)
cached_path-1.1.5.tar.gz(22.60 KB)
v1.1.4(Jun 29, 2022)
What's new

Changed ⚠️

Added support for latest huggingface_hub client library (v0.8.1), but dropped support for older versions.

Commits

d4123a8 Bump furo from 2022.6.4.1 to 2022.6.21 (#103) 026591c Update huggingface-hub requirement from <0.8.0,>=0.0.12 to >=0.0.12,<0.9.0 (#104) a9b4a42 Bump black from 22.3.0 to 22.6.0 (#105) 0c928af Bump sphinx from 5.0.1 to 5.0.2 (#102)
Source code(tar.gz)
Source code(zip)
cached_path-1.1.4-py3-none-any.whl(25.88 KB)
cached_path-1.1.4.tar.gz(22.62 KB)
v1.1.3(Jun 13, 2022)
What's new

Added 🎉

Added quiet parameter to cached_path() for turning off progress displays, and progress parameter for customizing displays.

Added SchemeClient.get_size() method.

Changed ⚠️

Switched to rich for progress displays, removed dependency on tqdm.

Removed 👋

Removed file_friendly_logging() function.

Commits

3be7f39 Fix and add test for ambiguous url error (#101) e4a23e4 Bump sphinx from 4.5.0 to 5.0.1 (#97) 2461e62 Bump myst-parser from 0.17.2 to 0.18.0 (#98) 1c53c8e Bump furo from 2022.4.7 to 2022.6.4.1 (#99) 85f593f Bump mypy from 0.960 to 0.961 (#100) 9665857 Switch to rich for progress (#94) c08c9e7 Bump mypy from 0.950 to 0.960 (#91) ea1c903 Update huggingface-hub requirement (#92) 4a3ead8 Update filelock requirement from <3.7,>=3.4 to >=3.4,<3.8 (#90) 3e9f05c Bump mypy from 0.942 to 0.950 (#88) afff17b Bump myst-parser from 0.17.0 to 0.17.2 (#87)
Source code(tar.gz)
Source code(zip)
cached_path-1.1.3-py3-none-any.whl(25.84 KB)
cached_path-1.1.3.tar.gz(22.61 KB)
v1.1.2(Apr 8, 2022)

What's new

Commits

f902fcf Revert "Prepare for release v1.1.2" 121dc8f Prepare for release v1.1.2 c82c6d2 Merge remote-tracking branch 'origin/main' 44698c0 Revert "Prepare for release v1.1.2" b263147 Prepare for release v1.1.2 656ad41 Merge remote-tracking branch 'origin/main' 6e4975f Revert "Prepare for release v1.1.2" 62d94ce Prepare for release v1.1.2 b63bf42 Merge pull request #80 from allenai/dependabot/pip/sphinx-4.5.0 b8298bd Merge pull request #82 from allenai/dependabot/pip/tqdm-gte-4.62-and-lt-4.65 aa1df62 Bump responses from 0.19.0 to 0.20.0 (#75) c731cbb Merge pull request #83 from allenai/dependabot/pip/huggingface-hub-gte-0.0.12-and-lt-0.6.0 922a765 Merge pull request #84 from allenai/dependabot/pip/furo-2022.4.7 b023495 Merge pull request #81 from allenai/dependabot/pip/black-22.3.0 d644ab2 only run tests on every Python version (#79)
Source code(tar.gz)
Source code(zip)
cached_path-1.1.2-py3-none-any.whl(26.22 KB)
cached_path-1.1.2.tar.gz(22.86 KB)
v1.1.1(Mar 25, 2022)
What's new

Fixed ✅

Fixed bug where cached_path() would fail to find local files with the home shortcut "~/" in their path.

Commits

d8a71a3 fix bug with home shortcut (#78) 989c5d5 Bump mypy from 0.931 to 0.942 (#77) 3b94013 Bump responses from 0.18.0 to 0.19.0 (#72) 1d3b538 Bump furo from 2022.2.23 to 2022.3.4 (#71) 6f054f7 automatically get year for copyright db51649 update copyright year de6fdc8 fix typo
Source code(tar.gz)
Source code(zip)
cached_path-1.1.1-py3-none-any.whl(26.21 KB)
cached_path-1.1.1.tar.gz(22.85 KB)
v1.1.0(Mar 3, 2022)
What's new

Changed ⚠️

Python >= 3.7 now required.

cached_path() now returns a Path instead of a str.

Commits

c824d18 change return type to "Path", add doctests (#70) 30767a5 bulk dependency upgrades and type fixes (#69) b4a5395 Update huggingface-hub requirement (#57) 2886a83 Bump sphinx from 4.3.2 to 4.4.0 (#59) a3b5e66 Bump black from 21.12b0 to 22.1.0 (#60) f89e348 Bump furo from 2021.11.23 to 2022.1.2 (#54) 718456a Bump sphinx from 4.3.1 to 4.3.2 (#51) 7873eb2 Bump responses from 0.16.0 to 0.17.0 (#56) c9cc125 Update google-cloud-storage requirement from <2.0,>=1.0 to >=1.0,<3.0 (#58)
Source code(tar.gz)
Source code(zip)
cached_path-1.1.0-py3-none-any.whl(26.21 KB)
cached_path-1.1.0.tar.gz(22.83 KB)
v1.0.2(Dec 23, 2021)
What's new

Fixed ✅

Fixed snapshot downloads from HuggingFace Hub.

Commits

4ac07b9 fix snapshot downloads from HuggingFace Hub 6df66c6 Bump myst-parser from 0.15.2 to 0.16.1 (#49) 0971549 Bump black from 21.11b1 to 21.12b0 (#46) 5223e6e improve release notes script
Source code(tar.gz)
Source code(zip)
cached_path-1.0.2-py3-none-any.whl(26.13 KB)
cached_path-1.0.2.tar.gz(22.73 KB)
v1.0.1(Dec 2, 2021)
What's new

Added 🎉

Added support for latest version of huggingface-hub (v0.2.0).

Commits

5a7aa3f Update huggingface-hub requirement (#45) d6aaa57 fix prerelease indicator condition in CI 393cb3f Merge pull request #43 from allenai/dependabot/pip/sphinx-4.3.1 c828314 Merge branch 'main' into dependabot/pip/sphinx-4.3.1 72fa38d We are stable now 61f4337 Merge branch 'main' into dependabot/pip/sphinx-4.3.1 d426ca3 Bump sphinx from 4.3.0 to 4.3.1
Source code(tar.gz)
Source code(zip)
cached_path-1.0.1-py3-none-any.whl(26.11 KB)
cached_path-1.0.1.tar.gz(22.72 KB)
v1.0.0(Nov 29, 2021)
What's new

Removed 👋

Removed dependency on the overrides package

Commits

a76e7f4 Merge pull request #44 from allenai/NoOverrides 2749b84 Removed dependency on the overrides package 675e2b6 Bump furo from 2021.11.16 to 2021.11.23 (#42)
Source code(tar.gz)
Source code(zip)
cached_path-1.0.0-py3-none-any.whl(26.11 KB)
cached_path-1.0.0.tar.gz(22.74 KB)
v0.3.4(Nov 20, 2021)

What's new

Commits

3866e83 Remove check_signature (#41) e9d5e79 Bump black from 21.11b0 to 21.11b1 (#40)
Source code(tar.gz)
Source code(zip)
cached_path-0.3.4-py3-none-any.whl(26.17 KB)
cached_path-0.3.4.tar.gz(22.75 KB)
v0.3.3(Nov 17, 2021)
What's new

Changed ⚠️

filelock >= 3.4 required.

Commits

0029615 Bump version to v0.3.3 for release 8d32dc9 fix 18bb826 Bump version to v0.3.3 for release 00ca3b7 Update filelock requirement from <3.4,>=3.3 to >=3.3,<3.5 (#37) e09c5f6 Bump black from 21.10b0 to 21.11b0 (#38) f7a2e4f Bump furo from 2021.11.12 to 2021.11.16 (#36) 4fbe927 Bump responses from 0.15.0 to 0.16.0 (#39) b6adfab Bump furo from 2021.10.9 to 2021.11.12 (#34) e1cf949 Bump sphinx from 4.2.0 to 4.3.0 (#33) 59a77e5 Bump isort from 5.10.0 to 5.10.1 (#32) 4878d66 Bump isort from 5.9.3 to 5.10.0 (#31)
Source code(tar.gz)
Source code(zip)
cached_path-0.3.3-py3-none-any.whl(26.25 KB)
cached_path-0.3.3.tar.gz(22.82 KB)
v0.3.2(Nov 3, 2021)
What's new

Changed ⚠️

Updated HuggingFace Hub requirement to support 0.1.0.

Commits

792e9ed updates and upgrades (#30)
Source code(tar.gz)
Source code(zip)
cached_path-0.3.2-py3-none-any.whl(26.18 KB)
cached_path-0.3.2.tar.gz(22.73 KB)
v0.3.1(Oct 7, 2021)
What's new

Fixed ✅

Fixed FileLock issue that overrides was complaining about.

Commits

ed3292e upgrade filelock (#25) 09c3fdd move CHANGELOG check to seperate workflow bef9208 add intersphinx links 27318bd add source code to docs a04dad0 add tqdm to requirements d8b12c2 update FileLock 6b484fc add note about FILE_FRIENDLY_LOGGING env var 988a53e source README for parts of the docs 4c58c79 Bump furo from 2021.9.8 to 2021.9.22 (#23) 9a318bc mark tests with external requests as flaky 46c4dd6 add pytest to dev-requirements e207ebe update test case bb29fb0 add issue and PR templates 102e741 add contributing guidelines
Source code(tar.gz)
Source code(zip)
cached_path-0.3.1-py3-none-any.whl(25.97 KB)
cached_path-0.3.1.tar.gz(22.52 KB)
v0.3.0(Sep 23, 2021)
What's new

Changed ⚠️

Renamed SchemeClient.connection_error_types to recoverable_errors, and included requests.exceptions.Timeout.

HttpClient now considers 502, 503, and 504 as recoverable_errors.

Commits

a39d25a Improve error handling (#24) 5715ea5 ensure 'is_url_or_existing_file' is import to init c7793af fix typo
Source code(tar.gz)
Source code(zip)
cached_path-0.3.0-py3-none-any.whl(25.63 KB)
cached_path-0.3.0.tar.gz(22.01 KB)
v0.2.0(Sep 22, 2021)
What's new

Added 🎉

Added function set_cache_dir for overriding the global default cache directory.

Added function get_cache_dir for getting the global default cache directory.

Added function add_scheme_client for extending cached_path to handle more URL schemes.

Added function file_friendly_logging to turn file friendly logging on globally.

Changed ⚠️

_Meta dataclass renamed to Meta.

FileLock moved to cached_path.file_lock.

CacheFile moved to cached_path.cache_file.

The download progress bar uses 1024 instead of 1000 as the unit scale.

AWS S3 and Google Cloud Storage downloads now have a progress bar.

Fixed ✅

For HTTP resources, when the server returns a 404 cached_path() now raises FileNotFoundError for consistency.

Fixed fetching ETag / MD5 hash for Google Cloud Storage resources.

Made Google Cloud Storage requests more robust by adding a retry policy and checking MD5 sums.

Commits

4d0d8a8 add docs badge and links to README f50aaf0 no fail on warning 1888052 add .readthedocs.yaml da2a51e Sphinx docs and other small improvements (#16) 745c11a run checks on other Python versions (#22) c7d341f Merge pull request #15 from allenai/organization 78be892 update README, support Python 3.6 c259e9b split up functionality 65dac80 create submodule for protocols c86c2e0 move CacheFile to own submodule 02b728f move FileLock to own submodule bda6448 rename _Meta -> Meta ec138b9 Bump responses from 0.13.4 to 0.14.0 (#14) 6a4f5b0 Bump responses from 0.13.3 to 0.13.4 (#2) 7cd7db5 Use tqdm with 1024 instead of 1000 unit scale (#12) c0194ba Bump overrides from 3.1.0 to 6.1.0 (#3) 81f92db Bump black from 21.8b0 to 21.9b0 (#13) c5f192a Bump black from 21.7b0 to 21.8b0 (#1) 71d5c78 Update README.md
Source code(tar.gz)
Source code(zip)
cached_path-0.2.0-py3-none-any.whl(25.45 KB)
cached_path-0.2.0.tar.gz(21.86 KB)
v0.1.0(Sep 10, 2021)
What's new

Added 🎉

Added code for a file utility library that provides a unified, simple interface for accessing both local and remote files. This can be used behind other APIs that need to access files agnostic to where they are located.

Commits

fe599f8 Bump version to v0.1.0 for release
Source code(tar.gz)
Source code(zip)
cached_path-0.1.0-py3-none-any.whl(17.88 KB)
cached_path-0.1.0.tar.gz(18.09 KB)

A file utility for accessing both local and remote files through a unified interface.

Related tags

Overview

Quick links

Installation

Installing with pip

Installing from source

Usage

Cache directory

Team

License

Comments

Checklist

Description

Related issues or possible duplicates

Environment

Steps to reproduce

5.11.3

Changes

:beetle: Fixes

:construction_worker: Continuous Integration

v5.11.3

Changes

:beetle: Fixes

:construction_worker: Continuous Integration

5.11.2

Changes

5.11.1

Changes December 12 2022

:beetle: Fixes

5.11.0

Changes December 12 2022

5.11.3 December 16 2022

5.11.2 December 12 2022

5.11.1 December 12 2022

5.11.0 December 12 2022

5.11.2

Changes

5.11.1

Changes December 12 2022

:beetle: Fixes

5.11.0

Changes December 12 2022

:construction_worker: Continuous Integration

:package: Dependencies

5.11.2 December 12 2022

5.11.1 December 12 2022

5.11.0 December 12 2022

5.11.1

Changes December 12 2022

:beetle: Fixes

5.11.0

Changes December 12 2022

:construction_worker: Continuous Integration

:package: Dependencies

5.11.1 December 12 2022

5.11.0 December 12 2022

v5.2.1

v5.2.0

Release 5.2.1 (released Sep 24, 2022)

Bugs fixed

Release 5.2.0.post0 (released Sep 24, 2022)

Release 5.2.0 (released Sep 24, 2022)

Dependencies

Deprecated

Features added

v5.1.0

Release 5.1.0 (released Jul 24, 2022)

Dependencies

Deprecated

Features added

Bugs fixed

v5.0.0b1

Release 5.0.0 (released May 30, 2022)

Dependencies

Incompatible changes

Deprecated

0.21.0

0.21.0

v0.6.0: fastai support, repocard metadata, binary file support, skip LFS files when pushing to the hub

Installing with `pip`

Automatic binary file tracking in `Repository`

`skip_lfs_file` is now added to mixins