Skip to content

Adding more documention and getting typing (pre-commit) working. #701

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
zeoticus wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Adding more documention and getting typing (pre-commit) working. #701

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4c54f0f
Added more documentio and reorganized code
Jun 2, 2025
84c606b
Applied consistent typing; fixed issue #518; fixing to pass pre-commit
Jun 14, 2025
59a34a9
Merge branch 'master' into issue699
zeoticus Jul 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion internetarchive/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,8 +70,8 @@
'configure',
'delete',
'download',
'get_files',
# API.
'get_files',
'get_item',
'get_session',
'get_tasks',
Expand Down
116 changes: 59 additions & 57 deletions internetarchive/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,13 @@
from typing import Iterable, Mapping, MutableMapping

import requests
from requests import PreparedRequest, Request, Response
from urllib3 import Retry

from internetarchive import auth, catalog, files, item, search, session
from internetarchive import config as config_module
from internetarchive.exceptions import AuthenticationError
from internetarchive.files import File


def get_session(
Expand Down Expand Up @@ -105,7 +107,7 @@ def get_item(
:py:class:`requests.adapters.HTTPAdapter` takes.

:param request_kwargs: Keyword arguments that
:py:class:`requests.Request` takes.
:py:class:`Request` takes.

:returns: The Item that fits the criteria.

Expand All @@ -119,16 +121,17 @@ def get_item(
archive_session = get_session(config, config_file, debug, http_adapter_kwargs)
return archive_session.get_item(identifier, request_kwargs=request_kwargs)


# mypy is confused
# mypy: disable-error-code="return-value"
def get_files(
identifier: str,
files: files.File | list[files.File] | None = None,
formats: str | list[str] | None = None,
glob_pattern: str | None = None,
exclude_pattern: str | None = None,
on_the_fly: bool = False,
**get_item_kwargs,
) -> list[files.File]:
identifier: str,
files: files.File | list[files.File] | None = None,
formats: str | list[str] | None = None,
glob_pattern: str | None = None,
exclude_pattern: str | None = None,
on_the_fly: bool = False,
**get_item_kwargs,
) -> list[File]:
r"""Get :class:`File` objects from an item.

:param identifier: The globally unique Archive.org identifier for a given item.
Expand Down Expand Up @@ -157,7 +160,6 @@ def get_files(
item = get_item(identifier, **get_item_kwargs)
return item.get_files(files, formats, glob_pattern, exclude_pattern, on_the_fly)


def modify_metadata(
identifier: str,
metadata: Mapping,
Expand All @@ -168,9 +170,9 @@ def modify_metadata(
access_key: str | None = None,
secret_key: str | None = None,
debug: bool = False,
request_kwargs: Mapping | None = None,
request_kwargs: dict | None = None,
**get_item_kwargs,
) -> requests.Request | requests.Response:
) -> PreparedRequest | Response | Request :
r"""Modify the metadata of an existing item on Archive.org.

:param identifier: The globally unique Archive.org identifier for a given item.
Expand All @@ -191,7 +193,7 @@ def modify_metadata(

:param secret_key: IA-S3 secret_key to use when making the given request.

:param debug: set to True to return a :class:`requests.Request <Request>`
:param debug: set to True to return a :class:`Request <Request>`
object instead of sending request. Defaults to ``False``.

:param \*\*get_item_kwargs: Arguments that ``get_item`` takes.
Expand All @@ -214,24 +216,24 @@ def modify_metadata(


def upload(
identifier: str,
files,
metadata: Mapping | None = None,
headers: dict | None = None,
access_key: str | None = None,
secret_key: str | None = None,
queue_derive=None,
verbose: bool = False,
verify: bool = False,
checksum: bool = False,
delete: bool = False,
retries: int | None = None,
retries_sleep: int | None = None,
debug: bool = False,
validate_identifier: bool = False,
request_kwargs: dict | None = None,
**get_item_kwargs,
) -> list[requests.Request | requests.Response]:
identifier: str,
files,
metadata: Mapping | None = None,
headers: dict | None = None,
access_key: str | None = None,
secret_key: str | None = None,
queue_derive=None,
verbose: bool = False,
verify: bool = False,
checksum: bool = False,
delete: bool = False,
retries: int | None = None,
retries_sleep: int | None = None,
debug: bool = False,
validate_identifier: bool = False,
request_kwargs: dict | None = None,
**get_item_kwargs,
) -> list[PreparedRequest | Response | Request]:
r"""Upload files to an item. The item will be created if it does not exist.

:param identifier: The globally unique Archive.org identifier for a given item.
Expand Down Expand Up @@ -297,26 +299,26 @@ def upload(


def download(
identifier: str,
files: files.File | list[files.File] | None = None,
formats: str | list[str] | None = None,
glob_pattern: str | None = None,
dry_run: bool = False,
verbose: bool = False,
ignore_existing: bool = False,
checksum: bool = False,
checksum_archive: bool = False,
destdir: str | None = None,
no_directory: bool = False,
retries: int | None = None,
item_index: int | None = None,
ignore_errors: bool = False,
on_the_fly: bool = False,
return_responses: bool = False,
no_change_timestamp: bool = False,
timeout: float | tuple[int, float] | None = None,
**get_item_kwargs,
) -> list[requests.Request | requests.Response]:
identifier: str,
files: files.File | list[files.File] | None = None,
formats: str | list[str] | None = None,
glob_pattern: str | None = None,
dry_run: bool = False,
verbose: bool = False,
ignore_existing: bool = False,
checksum: bool = False,
checksum_archive: bool = False,
destdir: str | None = None,
no_directory: bool = False,
retries: int | None = None,
item_index: int | None = None,
ignore_errors: bool = False,
on_the_fly: bool = False,
return_responses: bool = False,
no_change_timestamp: bool = False,
timeout: float | tuple[int, float] | None = None,
**get_item_kwargs,
) -> list[Response | Request]:
r"""Download files from an item.

:param identifier: The globally unique Archive.org identifier for a given item.
Expand Down Expand Up @@ -398,7 +400,7 @@ def delete(
verbose: bool = False,
debug: bool = False,
**kwargs,
) -> list[requests.Request | requests.Response]:
) -> list[Response | Request]:
"""Delete files from an item. Note: Some system files, such as <itemname>_meta.xml,
cannot be deleted.

Expand Down Expand Up @@ -466,16 +468,16 @@ def get_tasks(

def search_items(
query: str,
fields: Iterable | None = None,
fields: list | None = None,
sorts=None,
params: Mapping | None = None,
params: dict | None = None,
full_text_search: bool = False,
dsl_fts: bool = False,
archive_session: session.ArchiveSession | None = None,
config: Mapping | None = None,
config_file: str | None = None,
http_adapter_kwargs: MutableMapping | None = None,
request_kwargs: Mapping | None = None,
request_kwargs: dict | None = None,
max_retries: int | Retry | None = None,
) -> search.Search:
"""Search for items on Archive.org.
Expand Down Expand Up @@ -504,7 +506,7 @@ def search_items(
:py:class:`requests.adapters.HTTPAdapter` takes.

:param request_kwargs: Keyword arguments that
:py:class:`requests.Request` takes.
:py:class:`Request` takes.

:param max_retries: The number of times to retry a failed request.
This can also be an `urllib3.Retry` object.
Expand Down
Loading