-

dxf module

+

dxf module

@@ -45,10 +45,10 @@

dxf module

Module for accessing a Docker v2 Registry

+

Module for accessing a Docker v2 Registry

-class dxf.DXF(host: str, repo: str, auth: Callable[[DXFBase, Response], None] | None = None, insecure: bool = False, auth_host: str | None = None, tlsverify: bool | str = True, timeout: float | None = None)
+class dxf.DXF(host: str, repo: str, auth: Callable[[DXFBase, Response], None] | None = None, insecure: bool = False, auth_host: str | None = None, tlsverify: bool | str = True, timeout: float | None = None)

Bases: DXFBase

Class for operating on a Docker v2 repositories.

@@ -66,7 +66,7 @@

dxf module
-api_version_check() Tuple[str, Response]
+api_version_check() Tuple[str, Response]

Performs API version check

Returns:
@@ -77,7 +77,7 @@

dxf module
-blob_size(digest: str) int
+blob_size(digest: str) int

Return the size of a blob in the registry given the hash of its content.

Parameters:
@@ -91,7 +91,7 @@

dxf module
-del_alias(alias: str) List[str] | Dict[str, str]
+del_alias(alias: str) List[str] | Dict[str, str]

Delete an alias from the registry. The blobs it points to won’t be deleted. Use del_blob() for that.

Note

@@ -110,7 +110,7 @@

dxf module
-del_blob(digest: str)
+del_blob(digest: str)

Delete a blob from the registry given the hash of its content.

Parameters:
@@ -121,7 +121,7 @@

dxf module
-classmethod from_base(base: DXFBase, repo: str) TD
+classmethod from_base(base: DXFBase, repo: str) TD

Create a DXF object which uses the same host, settings and session as an existing DXFBase object.

@@ -139,7 +139,7 @@

dxf module
-get_alias(alias: str | None = None, manifest: str | None = None, verify: bool = True, sizes: bool = False, platform: str | None = None) List[str] | List[Tuple[str, int]] | Dict[str, List[str] | List[Tuple[str, int]]]
+get_alias(alias: str | None = None, manifest: str | None = None, verify: bool = True, sizes: bool = False, platform: str | None = None) List[str] | List[Tuple[str, int]] | Dict[str, List[str] | List[Tuple[str, int]]]

Get the blob hashes assigned to an alias.

Parameters:
@@ -159,7 +159,7 @@

dxf module
-get_digest(alias: str | None = None, manifest: str | None = None, platform: str | None = None) str | Dict[str, str]
+get_digest(alias: str | None = None, manifest: str | None = None, platform: str | None = None) str | Dict[str, str]

(v2 schema only) Get the hash of an alias’s configuration blob.

For an alias created using dxf, this is the hash of the first blob assigned to the alias.

@@ -181,7 +181,7 @@

dxf module
-get_manifest(alias: str, platform: str | None = None) str | Dict[str, str]
+get_manifest(alias: str, platform: str | None = None) str | Dict[str, str]

Get the manifest for an alias

Parameters:
@@ -198,7 +198,7 @@

dxf module
-get_manifest_and_response(alias: str) Tuple[str, Response]
+get_manifest_and_response(alias: str) Tuple[str, Response]

Request the manifest for an alias and return the manifest and the response.

@@ -213,7 +213,7 @@

dxf module
-list_aliases(batch_size: int | None = None, iterate: bool = False) Iterable[str] | List[str]
+list_aliases(batch_size: int | None = None, iterate: bool = False) Iterable[str] | List[str]

List all aliases defined in the repository.

Parameters:
@@ -230,7 +230,7 @@

dxf module
-mount_blob(repo: str, digest: str) str
+mount_blob(repo: str, digest: str) str

Mount a blob from another repository in the registry.

Parameters:
@@ -247,7 +247,7 @@

dxf module
-pull_blob(digest: str, size: bool = False, chunk_size: int | None = None) Iterable[bytes] | Tuple[Iterable[bytes], int]
+pull_blob(digest: str, size: bool = False, chunk_size: int | None = None) Iterable[bytes] | Tuple[Iterable[bytes], int]

Download a blob from the registry given the hash of its content.

Parameters:
@@ -265,7 +265,7 @@

dxf module
-push_blob(filename: str | None = None, progress: Callable[[str, bytes, int], None] | None = None, data: Iterable[bytes] | None = None, digest: str | None = None, check_exists: bool = True) str
+push_blob(filename: str | None = None, progress: Callable[[str, bytes, int], None] | None = None, data: Iterable[bytes] | None = None, digest: str | None = None, check_exists: bool = True) str

Upload a file to the registry and return its (SHA-256) hash.

The registry is content-addressable so the file’s content (aka blob) can be retrieved later by passing the hash to pull_blob().

@@ -287,7 +287,7 @@

dxf module
-set_alias(alias: str, *digests: str) str
+set_alias(alias: str, *digests: str) str

Give a name (alias) to a set of blobs. Each blob is specified by the hash of its content.

@@ -305,7 +305,7 @@

dxf module
-set_manifest(alias: str, manifest_json: str)
+set_manifest(alias: str, manifest_json: str)

Give a name (alias) to a manifest.

Parameters:
@@ -321,7 +321,7 @@

dxf module
-class dxf.DXFBase(host: str, auth: Callable[[DXFBase, Response], None] | None = None, insecure: bool = False, auth_host: str | None = None, tlsverify: bool | str = True, timeout: float | None = None)
+class dxf.DXFBase(host: str, auth: Callable[[DXFBase, Response], None] | None = None, insecure: bool = False, auth_host: str | None = None, tlsverify: bool | str = True, timeout: float | None = None)

Bases: object

Class for communicating with a Docker v2 registry. Contains only operations which aren’t related to repositories.

@@ -349,7 +349,7 @@

dxf module
-authenticate(username: str | None = None, password: str | None = None, actions: List[str] | None = None, response: Response | None = None, authorization: str | None = None, user_agent: str = 'Docker-Client/19.03.2 (linux)') str | None
+authenticate(username: str | None = None, password: str | None = None, actions: List[str] | None = None, response: Response | None = None, authorization: str | None = None, user_agent: str = 'Docker-Client/19.03.2 (linux)') str | None

Authenticate to the registry using a username and password, an authorization header or otherwise as the anonymous user.

@@ -371,7 +371,7 @@

dxf module
-list_repos(batch_size: int | None = None, iterate: bool = False) List[str] | Iterable[str]
+list_repos(batch_size: int | None = None, iterate: bool = False) List[str] | Iterable[str]

List all repositories in the registry.

Parameters:
@@ -388,7 +388,7 @@

dxf module
-property token
+property token

str: Authentication token. This will be obtained automatically when you call authenticate(). If you’ve obtained a token previously, you can also set it but be aware tokens expire quickly.

@@ -398,7 +398,7 @@

dxf module
-dxf.hash_bytes(buf: bytes) str
+dxf.hash_bytes(buf: bytes) str

Hash bytes using the same method the registry uses (currently SHA-256).

Parameters:
@@ -412,7 +412,7 @@

dxf module
-dxf.hash_file(filename: str) str
+dxf.hash_file(filename: str) str

Hash a file using the same method the registry uses (currently SHA-256).

Parameters:
@@ -426,18 +426,18 @@

dxf module -

dxf.exceptions module

+

dxf.exceptions module

Module containing exceptions thrown by dxf.

-exception dxf.exceptions.DXFAuthInsecureError
+exception dxf.exceptions.DXFAuthInsecureError

Bases: DXFError

Can’t authenticate over insecure (non-HTTPS) connection

-exception dxf.exceptions.DXFDigestMismatchError(got, expected)
+exception dxf.exceptions.DXFDigestMismatchError(got, expected)

Bases: DXFUnexpectedError

Digest didn’t match expected value

@@ -452,7 +452,7 @@

dxf module
-exception dxf.exceptions.DXFDigestNotAvailableForSchema1
+exception dxf.exceptions.DXFDigestNotAvailableForSchema1

Bases: DXFError

https://github.com/docker/distribution/issues/1662#issuecomment-213101772 A schema1 manifest should always produce the same image id but defining the @@ -461,7 +461,7 @@

dxf module
-exception dxf.exceptions.DXFDisallowedSignatureAlgorithmError(alg)
+exception dxf.exceptions.DXFDisallowedSignatureAlgorithmError(alg)

Bases: DXFError

Signature algorithm forbidden

@@ -473,21 +473,21 @@

dxf module
-exception dxf.exceptions.DXFError
+exception dxf.exceptions.DXFError

Bases: Exception

Base exception class for all dxf errors

-exception dxf.exceptions.DXFMountFailed
+exception dxf.exceptions.DXFMountFailed

Bases: DXFError

Failed to mount blob from another repository.

-exception dxf.exceptions.DXFPlatformDataNotFound(platform)
+exception dxf.exceptions.DXFPlatformDataNotFound(platform)

Bases: DXFError

Platform data not found

@@ -499,21 +499,21 @@

dxf module
-exception dxf.exceptions.DXFSignatureChainNotImplementedError
+exception dxf.exceptions.DXFSignatureChainNotImplementedError

Bases: DXFError

Signature chains not supported

-exception dxf.exceptions.DXFUnauthorizedError
+exception dxf.exceptions.DXFUnauthorizedError

Bases: DXFError

Registry returned authorized error

-exception dxf.exceptions.DXFUnexpectedDigestMethodError(got, expected)
+exception dxf.exceptions.DXFUnexpectedDigestMethodError(got, expected)

Bases: DXFUnexpectedError

Digest method not supported

@@ -528,7 +528,7 @@

dxf module
-exception dxf.exceptions.DXFUnexpectedError(got, expected)
+exception dxf.exceptions.DXFUnexpectedError(got, expected)

Bases: DXFError

Unexpected value error

@@ -543,7 +543,7 @@

dxf module
-exception dxf.exceptions.DXFUnexpectedKeyTypeError(got, expected)
+exception dxf.exceptions.DXFUnexpectedKeyTypeError(got, expected)

Bases: DXFUnexpectedError

Cryptographic key type not supported

@@ -558,7 +558,7 @@

dxf module
-exception dxf.exceptions.DXFUnexpectedStatusCodeError(got, expected)
+exception dxf.exceptions.DXFUnexpectedStatusCodeError(got, expected)

Bases: DXFUnexpectedError

Unexpected HTTP status code

@@ -573,14 +573,14 @@

dxf module
-exception dxf.exceptions.DXFUnsupportedSchemaType
+exception dxf.exceptions.DXFUnsupportedSchemaType

Bases: DXFError

Schema type (mediaType) is not recognized/supported

-

Indices and tables

+

Indices and tables

\ No newline at end of file diff --git a/docs/_build/html/objects.inv b/docs/_build/html/objects.inv index e5eb373..84fc241 100644 Binary files a/docs/_build/html/objects.inv and b/docs/_build/html/objects.inv differ diff --git a/docs/_build/html/py-modindex.html b/docs/_build/html/py-modindex.html index edbdf41..840cfa5 100644 --- a/docs/_build/html/py-modindex.html +++ b/docs/_build/html/py-modindex.html @@ -1,15 +1,15 @@ - + - Python Module Index — python-dxf 11.1.1 documentation - - - - - + Python Module Index — python-dxf 11.2.0 documentation + + + + + @@ -25,7 +25,7 @@

Navigation

  • modules |
  • - + @@ -89,13 +89,13 @@

    Navigation

  • modules |
  • - + \ No newline at end of file diff --git a/docs/_build/html/search.html b/docs/_build/html/search.html index 3a0f93c..5a88ab0 100644 --- a/docs/_build/html/search.html +++ b/docs/_build/html/search.html @@ -1,16 +1,16 @@ - + - Search — python-dxf 11.1.1 documentation - - + Search — python-dxf 11.2.0 documentation + + - - - + + + @@ -28,7 +28,7 @@

    Navigation

  • modules |
  • - + @@ -88,13 +88,13 @@

    Navigation

  • modules |
  • - + \ No newline at end of file diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js index ccad60d..9e72b54 100644 --- a/docs/_build/html/searchindex.js +++ b/docs/_build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["index"], "filenames": ["index.rst"], "titles": ["dxf module"], "terms": {"access": 0, "docker": 0, "v2": 0, "registri": 0, "class": 0, "host": 0, "str": 0, "repo": 0, "auth": 0, "callabl": 0, "dxfbase": 0, "respons": 0, "none": 0, "insecur": 0, "bool": 0, "fals": 0, "auth_host": 0, "tlsverifi": 0, "true": 0, "timeout": 0, "float": 0, "base": 0, "oper": 0, "repositori": 0, "paramet": 0, "name": 0, "can": 0, "contain": 0, "port": 0, "number": 0, "e": 0, "g": 0, "1": 0, "io": 0, "localhost": 0, "5000": 0, "typic": 0, "thi": 0, "i": 0, "form": 0, "usernam": 0, "reponam": 0, "your": 0, "own": 0, "you": 0, "don": 0, "t": 0, "actual": 0, "have": 0, "stick": 0, "authent": 0, "function": 0, "call": 0, "whenev": 0, "requir": 0, "receiv": 0, "object": 0, "http": 0, "It": 0, "should": 0, "password": 0, "befor": 0, "return": 0, "us": 0, "instead": 0, "which": 0, "default": 0, "when": 0, "connect": 0, "token": 0, "If": 0, "set": 0, "overrid": 0, "do": 0, "verifi": 0, "tl": 0, "certif": 0, "point": 0, "ca": 0, "bundl": 0, "crt": 0, "file": 0, "verif": 0, "see": 0, "request": 0, "more": 0, "detail": 0, "option": 0, "api_version_check": 0, "tupl": 0, "perform": 0, "api": 0, "version": 0, "check": 0, "verson": 0, "string": 0, "json": 0, "blob_siz": 0, "digest": 0, "int": 0, "size": 0, "blob": 0, "given": 0, "hash": 0, "its": 0, "content": 0, "": 0, "prefix": 0, "sha256": 0, "byte": 0, "del_alia": 0, "alia": 0, "list": 0, "dict": 0, "delet": 0, "an": 0, "from": 0, "The": 0, "won": 0, "del_blob": 0, "On": 0, "privat": 0, "garbag": 0, "collect": 0, "might": 0, "need": 0, "run": 0, "manual": 0, "doc": 0, "com": 0, "A": 0, "were": 0, "assign": 0, "For": 0, "multi": 0, "arch": 0, "alias": 0, "per": 0, "platform": 0, "ll": 0, "each": 0, "those": 0, "classmethod": 0, "from_bas": 0, "td": 0, "creat": 0, "same": 0, "session": 0, "exist": 0, "share": 0, "configur": 0, "also": 0, "get_alia": 0, "manifest": 0, "get": 0, "almost": 0, "definit": 0, "onli": 0, "pass": 0, "argument": 0, "previous": 0, "obtain": 0, "specifi": 0, "here": 0, "v1": 0, "schema": 0, "whether": 0, "integr": 0, "itself": 0, "chang": 0, "along": 0, "inform": 0, "falsei": 0, "ar": 0, "truthi": 0, "get_digest": 0, "first": 0, "imag": 0, "tag": 0, "inspect": 0, "format": 0, "id": 0, "get_manifest": 0, "get_manifest_and_respons": 0, "list_alias": 0, "batch_siz": 0, "iter": 0, "all": 0, "defin": 0, "ask": 0, "server": 0, "time": 0, "over": 0, "mount_blob": 0, "mount": 0, "anoth": 0, "pull_blob": 0, "chunk_siz": 0, "download": 0, "too": 0, "8192": 0, "push_blob": 0, "filenam": 0, "progress": 0, "data": 0, "check_exist": 0, "upload": 0, "sha": 0, "256": 0, "address": 0, "so": 0, "aka": 0, "retriev": 0, "later": 0, "isn": 0, "chunk": 0, "must": 0, "just": 0, "read": 0, "total": 0, "alreadi": 0, "again": 0, "set_alia": 0, "give": 0, "set_manifest": 0, "manifest_json": 0, "2": 0, "commun": 0, "aren": 0, "relat": 0, "act": 0, "context": 0, "manag": 0, "enter": 0, "new": 0, "exit": 0, "close": 0, "ephemer": 0, "underli": 0, "until": 0, "python": 0, "action": 0, "author": 0, "user_ag": 0, "client": 0, "19": 0, "03": 0, "linux": 0, "header": 0, "otherwis": 0, "anonym": 0, "user": 0, "know": 0, "type": 0, "make": 0, "them": 0, "valid": 0, "pull": 0, "push": 0, "constructor": 0, "back": 0, "automat": 0, "detect": 0, "valu": 0, "agent": 0, "support": 0, "bearer": 0, "basic": 0, "list_repo": 0, "properti": 0, "ve": 0, "awar": 0, "expir": 0, "quickli": 0, "hash_byt": 0, "buf": 0, "method": 0, "current": 0, "hex": 0, "encod": 0, "hash_fil": 0, "thrown": 0, "dxfauthinsecureerror": 0, "dxferror": 0, "non": 0, "dxfdigestmismatcherror": 0, "got": 0, "expect": 0, "dxfunexpectederror": 0, "didn": 0, "match": 0, "wa": 0, "dxfdigestnotavailableforschema1": 0, "github": 0, "distribut": 0, "issu": 0, "1662": 0, "issuecom": 0, "213101772": 0, "schema1": 0, "alwai": 0, "produc": 0, "step": 0, "directli": 0, "straight": 0, "forward": 0, "dxfdisallowedsignaturealgorithmerror": 0, "alg": 0, "signatur": 0, "algorithm": 0, "forbidden": 0, "error": 0, "dxfmountfail": 0, "fail": 0, "dxfplatformdatanotfound": 0, "found": 0, "dxfsignaturechainnotimplementederror": 0, "chain": 0, "dxfunauthorizederror": 0, "dxfunexpecteddigestmethoderror": 0, "unexpect": 0, "dxfunexpectedkeytypeerror": 0, "cryptograph": 0, "kei": 0, "dxfunexpectedstatuscodeerror": 0, "statu": 0, "code": 0, "dxfunsupportedschematyp": 0, "mediatyp": 0, "recogn": 0, "index": 0, "search": 0, "page": 0}, "objects": {"": [[0, 0, 0, "-", "dxf"]], "dxf": [[0, 1, 1, "", "DXF"], [0, 1, 1, "", "DXFBase"], [0, 0, 0, "-", "exceptions"], [0, 5, 1, "", "hash_bytes"], [0, 5, 1, "", "hash_file"]], "dxf.DXF": [[0, 2, 1, "", "api_version_check"], [0, 2, 1, "", "blob_size"], [0, 2, 1, "", "del_alias"], [0, 2, 1, "", "del_blob"], [0, 2, 1, "", "from_base"], [0, 2, 1, "", "get_alias"], [0, 2, 1, "", "get_digest"], [0, 2, 1, "", "get_manifest"], [0, 2, 1, "", "get_manifest_and_response"], [0, 2, 1, "", "list_aliases"], [0, 2, 1, "", "mount_blob"], [0, 2, 1, "", "pull_blob"], [0, 2, 1, "", "push_blob"], [0, 2, 1, "", "set_alias"], [0, 2, 1, "", "set_manifest"]], "dxf.DXFBase": [[0, 2, 1, "", "authenticate"], [0, 2, 1, "", "list_repos"], [0, 3, 1, "", "token"]], "dxf.exceptions": [[0, 4, 1, "", "DXFAuthInsecureError"], [0, 4, 1, "", "DXFDigestMismatchError"], [0, 4, 1, "", "DXFDigestNotAvailableForSchema1"], [0, 4, 1, "", "DXFDisallowedSignatureAlgorithmError"], [0, 4, 1, "", "DXFError"], [0, 4, 1, "", "DXFMountFailed"], [0, 4, 1, "", "DXFPlatformDataNotFound"], [0, 4, 1, "", "DXFSignatureChainNotImplementedError"], [0, 4, 1, "", "DXFUnauthorizedError"], [0, 4, 1, "", "DXFUnexpectedDigestMethodError"], [0, 4, 1, "", "DXFUnexpectedError"], [0, 4, 1, "", "DXFUnexpectedKeyTypeError"], [0, 4, 1, "", "DXFUnexpectedStatusCodeError"], [0, 4, 1, "", "DXFUnsupportedSchemaType"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:property", "4": "py:exception", "5": "py:function"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "property", "Python property"], "4": ["py", "exception", "Python exception"], "5": ["py", "function", "Python function"]}, "titleterms": {"dxf": 0, "modul": 0, "except": 0, "indic": 0, "tabl": 0}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 57}, "alltitles": {"dxf module": [[0, "dxf-module"]], "dxf.exceptions module": [[0, "module-dxf.exceptions"]], "Indices and tables": [[0, "indices-and-tables"]]}, "indexentries": {"dxf (class in dxf)": [[0, "dxf.DXF"]], "dxfauthinsecureerror": [[0, "dxf.exceptions.DXFAuthInsecureError"]], "dxfbase (class in dxf)": [[0, "dxf.DXFBase"]], "dxfdigestmismatcherror": [[0, "dxf.exceptions.DXFDigestMismatchError"]], "dxfdigestnotavailableforschema1": [[0, "dxf.exceptions.DXFDigestNotAvailableForSchema1"]], "dxfdisallowedsignaturealgorithmerror": [[0, "dxf.exceptions.DXFDisallowedSignatureAlgorithmError"]], "dxferror": [[0, "dxf.exceptions.DXFError"]], "dxfmountfailed": [[0, "dxf.exceptions.DXFMountFailed"]], "dxfplatformdatanotfound": [[0, "dxf.exceptions.DXFPlatformDataNotFound"]], "dxfsignaturechainnotimplementederror": [[0, "dxf.exceptions.DXFSignatureChainNotImplementedError"]], "dxfunauthorizederror": [[0, "dxf.exceptions.DXFUnauthorizedError"]], "dxfunexpecteddigestmethoderror": [[0, "dxf.exceptions.DXFUnexpectedDigestMethodError"]], "dxfunexpectederror": [[0, "dxf.exceptions.DXFUnexpectedError"]], "dxfunexpectedkeytypeerror": [[0, "dxf.exceptions.DXFUnexpectedKeyTypeError"]], "dxfunexpectedstatuscodeerror": [[0, "dxf.exceptions.DXFUnexpectedStatusCodeError"]], "dxfunsupportedschematype": [[0, "dxf.exceptions.DXFUnsupportedSchemaType"]], "api_version_check() (dxf.dxf method)": [[0, "dxf.DXF.api_version_check"]], "authenticate() (dxf.dxfbase method)": [[0, "dxf.DXFBase.authenticate"]], "blob_size() (dxf.dxf method)": [[0, "dxf.DXF.blob_size"]], "del_alias() (dxf.dxf method)": [[0, "dxf.DXF.del_alias"]], "del_blob() (dxf.dxf method)": [[0, "dxf.DXF.del_blob"]], "dxf": [[0, "module-dxf"]], "dxf.exceptions": [[0, "module-dxf.exceptions"]], "from_base() (dxf.dxf class method)": [[0, "dxf.DXF.from_base"]], "get_alias() (dxf.dxf method)": [[0, "dxf.DXF.get_alias"]], "get_digest() (dxf.dxf method)": [[0, "dxf.DXF.get_digest"]], "get_manifest() (dxf.dxf method)": [[0, "dxf.DXF.get_manifest"]], "get_manifest_and_response() (dxf.dxf method)": [[0, "dxf.DXF.get_manifest_and_response"]], "hash_bytes() (in module dxf)": [[0, "dxf.hash_bytes"]], "hash_file() (in module dxf)": [[0, "dxf.hash_file"]], "list_aliases() (dxf.dxf method)": [[0, "dxf.DXF.list_aliases"]], "list_repos() (dxf.dxfbase method)": [[0, "dxf.DXFBase.list_repos"]], "module": [[0, "module-dxf"], [0, "module-dxf.exceptions"]], "mount_blob() (dxf.dxf method)": [[0, "dxf.DXF.mount_blob"]], "pull_blob() (dxf.dxf method)": [[0, "dxf.DXF.pull_blob"]], "push_blob() (dxf.dxf method)": [[0, "dxf.DXF.push_blob"]], "set_alias() (dxf.dxf method)": [[0, "dxf.DXF.set_alias"]], "set_manifest() (dxf.dxf method)": [[0, "dxf.DXF.set_manifest"]], "token (dxf.dxfbase property)": [[0, "dxf.DXFBase.token"]]}}) \ No newline at end of file +Search.setIndex({"docnames": ["index"], "filenames": ["index.rst"], "titles": ["dxf module"], "terms": {"access": 0, "docker": 0, "v2": 0, "registri": 0, "class": 0, "host": 0, "str": 0, "repo": 0, "auth": 0, "callabl": 0, "dxfbase": 0, "respons": 0, "none": 0, "insecur": 0, "bool": 0, "fals": 0, "auth_host": 0, "tlsverifi": 0, "true": 0, "timeout": 0, "float": 0, "base": 0, "oper": 0, "repositori": 0, "paramet": 0, "name": 0, "can": 0, "contain": 0, "port": 0, "number": 0, "e": 0, "g": 0, "1": 0, "io": 0, "localhost": 0, "5000": 0, "typic": 0, "thi": 0, "i": 0, "form": 0, "usernam": 0, "reponam": 0, "your": 0, "own": 0, "you": 0, "don": 0, "t": 0, "actual": 0, "have": 0, "stick": 0, "authent": 0, "function": 0, "call": 0, "whenev": 0, "requir": 0, "receiv": 0, "object": 0, "http": 0, "It": 0, "should": 0, "password": 0, "befor": 0, "return": 0, "us": 0, "instead": 0, "which": 0, "default": 0, "when": 0, "connect": 0, "token": 0, "If": 0, "set": 0, "overrid": 0, "do": 0, "verifi": 0, "tl": 0, "certif": 0, "point": 0, "ca": 0, "bundl": 0, "crt": 0, "file": 0, "verif": 0, "see": 0, "request": 0, "more": 0, "detail": 0, "option": 0, "api_version_check": 0, "tupl": 0, "perform": 0, "api": 0, "version": 0, "check": 0, "verson": 0, "string": 0, "json": 0, "blob_siz": 0, "digest": 0, "int": 0, "size": 0, "blob": 0, "given": 0, "hash": 0, "its": 0, "content": 0, "": 0, "prefix": 0, "sha256": 0, "byte": 0, "del_alia": 0, "alia": 0, "list": 0, "dict": 0, "delet": 0, "an": 0, "from": 0, "The": 0, "won": 0, "del_blob": 0, "On": 0, "privat": 0, "garbag": 0, "collect": 0, "might": 0, "need": 0, "run": 0, "manual": 0, "doc": 0, "com": 0, "A": 0, "were": 0, "assign": 0, "For": 0, "multi": 0, "arch": 0, "alias": 0, "per": 0, "platform": 0, "ll": 0, "each": 0, "those": 0, "classmethod": 0, "from_bas": 0, "td": 0, "creat": 0, "same": 0, "session": 0, "exist": 0, "share": 0, "configur": 0, "also": 0, "get_alia": 0, "manifest": 0, "get": 0, "almost": 0, "definit": 0, "onli": 0, "pass": 0, "argument": 0, "previous": 0, "obtain": 0, "specifi": 0, "here": 0, "v1": 0, "schema": 0, "whether": 0, "integr": 0, "itself": 0, "chang": 0, "along": 0, "inform": 0, "falsei": 0, "ar": 0, "truthi": 0, "get_digest": 0, "first": 0, "imag": 0, "tag": 0, "inspect": 0, "format": 0, "id": 0, "get_manifest": 0, "get_manifest_and_respons": 0, "list_alias": 0, "batch_siz": 0, "iter": 0, "all": 0, "defin": 0, "ask": 0, "server": 0, "time": 0, "over": 0, "mount_blob": 0, "mount": 0, "anoth": 0, "pull_blob": 0, "chunk_siz": 0, "download": 0, "too": 0, "8192": 0, "push_blob": 0, "filenam": 0, "progress": 0, "data": 0, "check_exist": 0, "upload": 0, "sha": 0, "256": 0, "address": 0, "so": 0, "aka": 0, "retriev": 0, "later": 0, "isn": 0, "chunk": 0, "must": 0, "just": 0, "read": 0, "total": 0, "alreadi": 0, "again": 0, "set_alia": 0, "give": 0, "set_manifest": 0, "manifest_json": 0, "2": 0, "commun": 0, "aren": 0, "relat": 0, "act": 0, "context": 0, "manag": 0, "enter": 0, "new": 0, "exit": 0, "close": 0, "ephemer": 0, "underli": 0, "until": 0, "python": 0, "action": 0, "author": 0, "user_ag": 0, "client": 0, "19": 0, "03": 0, "linux": 0, "header": 0, "otherwis": 0, "anonym": 0, "user": 0, "know": 0, "type": 0, "make": 0, "them": 0, "valid": 0, "pull": 0, "push": 0, "constructor": 0, "back": 0, "automat": 0, "detect": 0, "valu": 0, "agent": 0, "support": 0, "bearer": 0, "basic": 0, "list_repo": 0, "properti": 0, "ve": 0, "awar": 0, "expir": 0, "quickli": 0, "hash_byt": 0, "buf": 0, "method": 0, "current": 0, "hex": 0, "encod": 0, "hash_fil": 0, "thrown": 0, "dxfauthinsecureerror": 0, "dxferror": 0, "non": 0, "dxfdigestmismatcherror": 0, "got": 0, "expect": 0, "dxfunexpectederror": 0, "didn": 0, "match": 0, "wa": 0, "dxfdigestnotavailableforschema1": 0, "github": 0, "distribut": 0, "issu": 0, "1662": 0, "issuecom": 0, "213101772": 0, "schema1": 0, "alwai": 0, "produc": 0, "step": 0, "directli": 0, "straight": 0, "forward": 0, "dxfdisallowedsignaturealgorithmerror": 0, "alg": 0, "signatur": 0, "algorithm": 0, "forbidden": 0, "error": 0, "dxfmountfail": 0, "fail": 0, "dxfplatformdatanotfound": 0, "found": 0, "dxfsignaturechainnotimplementederror": 0, "chain": 0, "dxfunauthorizederror": 0, "dxfunexpecteddigestmethoderror": 0, "unexpect": 0, "dxfunexpectedkeytypeerror": 0, "cryptograph": 0, "kei": 0, "dxfunexpectedstatuscodeerror": 0, "statu": 0, "code": 0, "dxfunsupportedschematyp": 0, "mediatyp": 0, "recogn": 0, "index": 0, "search": 0, "page": 0}, "objects": {"": [[0, 0, 0, "-", "dxf"]], "dxf": [[0, 1, 1, "", "DXF"], [0, 1, 1, "", "DXFBase"], [0, 0, 0, "-", "exceptions"], [0, 5, 1, "", "hash_bytes"], [0, 5, 1, "", "hash_file"]], "dxf.DXF": [[0, 2, 1, "", "api_version_check"], [0, 2, 1, "", "blob_size"], [0, 2, 1, "", "del_alias"], [0, 2, 1, "", "del_blob"], [0, 2, 1, "", "from_base"], [0, 2, 1, "", "get_alias"], [0, 2, 1, "", "get_digest"], [0, 2, 1, "", "get_manifest"], [0, 2, 1, "", "get_manifest_and_response"], [0, 2, 1, "", "list_aliases"], [0, 2, 1, "", "mount_blob"], [0, 2, 1, "", "pull_blob"], [0, 2, 1, "", "push_blob"], [0, 2, 1, "", "set_alias"], [0, 2, 1, "", "set_manifest"]], "dxf.DXFBase": [[0, 2, 1, "", "authenticate"], [0, 2, 1, "", "list_repos"], [0, 3, 1, "", "token"]], "dxf.exceptions": [[0, 4, 1, "", "DXFAuthInsecureError"], [0, 4, 1, "", "DXFDigestMismatchError"], [0, 4, 1, "", "DXFDigestNotAvailableForSchema1"], [0, 4, 1, "", "DXFDisallowedSignatureAlgorithmError"], [0, 4, 1, "", "DXFError"], [0, 4, 1, "", "DXFMountFailed"], [0, 4, 1, "", "DXFPlatformDataNotFound"], [0, 4, 1, "", "DXFSignatureChainNotImplementedError"], [0, 4, 1, "", "DXFUnauthorizedError"], [0, 4, 1, "", "DXFUnexpectedDigestMethodError"], [0, 4, 1, "", "DXFUnexpectedError"], [0, 4, 1, "", "DXFUnexpectedKeyTypeError"], [0, 4, 1, "", "DXFUnexpectedStatusCodeError"], [0, 4, 1, "", "DXFUnsupportedSchemaType"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:property", "4": "py:exception", "5": "py:function"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "property", "Python property"], "4": ["py", "exception", "Python exception"], "5": ["py", "function", "Python function"]}, "titleterms": {"dxf": 0, "modul": 0, "except": 0, "indic": 0, "tabl": 0}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 60}, "alltitles": {"dxf module": [[0, "dxf-module"]], "dxf.exceptions module": [[0, "module-dxf.exceptions"]], "Indices and tables": [[0, "indices-and-tables"]]}, "indexentries": {"dxf (class in dxf)": [[0, "dxf.DXF"]], "dxfauthinsecureerror": [[0, "dxf.exceptions.DXFAuthInsecureError"]], "dxfbase (class in dxf)": [[0, "dxf.DXFBase"]], "dxfdigestmismatcherror": [[0, "dxf.exceptions.DXFDigestMismatchError"]], "dxfdigestnotavailableforschema1": [[0, "dxf.exceptions.DXFDigestNotAvailableForSchema1"]], "dxfdisallowedsignaturealgorithmerror": [[0, "dxf.exceptions.DXFDisallowedSignatureAlgorithmError"]], "dxferror": [[0, "dxf.exceptions.DXFError"]], "dxfmountfailed": [[0, "dxf.exceptions.DXFMountFailed"]], "dxfplatformdatanotfound": [[0, "dxf.exceptions.DXFPlatformDataNotFound"]], "dxfsignaturechainnotimplementederror": [[0, "dxf.exceptions.DXFSignatureChainNotImplementedError"]], "dxfunauthorizederror": [[0, "dxf.exceptions.DXFUnauthorizedError"]], "dxfunexpecteddigestmethoderror": [[0, "dxf.exceptions.DXFUnexpectedDigestMethodError"]], "dxfunexpectederror": [[0, "dxf.exceptions.DXFUnexpectedError"]], "dxfunexpectedkeytypeerror": [[0, "dxf.exceptions.DXFUnexpectedKeyTypeError"]], "dxfunexpectedstatuscodeerror": [[0, "dxf.exceptions.DXFUnexpectedStatusCodeError"]], "dxfunsupportedschematype": [[0, "dxf.exceptions.DXFUnsupportedSchemaType"]], "api_version_check() (dxf.dxf method)": [[0, "dxf.DXF.api_version_check"]], "authenticate() (dxf.dxfbase method)": [[0, "dxf.DXFBase.authenticate"]], "blob_size() (dxf.dxf method)": [[0, "dxf.DXF.blob_size"]], "del_alias() (dxf.dxf method)": [[0, "dxf.DXF.del_alias"]], "del_blob() (dxf.dxf method)": [[0, "dxf.DXF.del_blob"]], "dxf": [[0, "module-dxf"]], "dxf.exceptions": [[0, "module-dxf.exceptions"]], "from_base() (dxf.dxf class method)": [[0, "dxf.DXF.from_base"]], "get_alias() (dxf.dxf method)": [[0, "dxf.DXF.get_alias"]], "get_digest() (dxf.dxf method)": [[0, "dxf.DXF.get_digest"]], "get_manifest() (dxf.dxf method)": [[0, "dxf.DXF.get_manifest"]], "get_manifest_and_response() (dxf.dxf method)": [[0, "dxf.DXF.get_manifest_and_response"]], "hash_bytes() (in module dxf)": [[0, "dxf.hash_bytes"]], "hash_file() (in module dxf)": [[0, "dxf.hash_file"]], "list_aliases() (dxf.dxf method)": [[0, "dxf.DXF.list_aliases"]], "list_repos() (dxf.dxfbase method)": [[0, "dxf.DXFBase.list_repos"]], "module": [[0, "module-dxf"], [0, "module-dxf.exceptions"]], "mount_blob() (dxf.dxf method)": [[0, "dxf.DXF.mount_blob"]], "pull_blob() (dxf.dxf method)": [[0, "dxf.DXF.pull_blob"]], "push_blob() (dxf.dxf method)": [[0, "dxf.DXF.push_blob"]], "set_alias() (dxf.dxf method)": [[0, "dxf.DXF.set_alias"]], "set_manifest() (dxf.dxf method)": [[0, "dxf.DXF.set_manifest"]], "token (dxf.dxfbase property)": [[0, "dxf.DXFBase.token"]]}}) \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index 86aa3ac..de42fe5 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -58,9 +58,9 @@ # built documents. # # The short X.Y version. -version = '11.1' +version = '11.2' # The full version, including alpha/beta/rc tags. -release = '11.1.1' +release = '11.2.0' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/dxf/__init__.py b/dxf/__init__.py index 00ae3f4..de776be 100644 --- a/dxf/__init__.py +++ b/dxf/__init__.py @@ -464,7 +464,7 @@ def pull_blob(self, digest: str, size: bool=False, chunk_size: Optional[int]=Non if chunk_size is None: chunk_size = 8192 r = self._request('get', 'blobs/' + digest, stream=True) - class Chunks(object): + class Chunks(Iterable[_binary_type]): # pylint: disable=too-few-public-methods def __iter__(self): sha256 = hashlib.sha256() diff --git a/htmlcov/index.html b/htmlcov/index.html index ac17a3e..44d75ab 100644 --- a/htmlcov/index.html +++ b/htmlcov/index.html @@ -47,7 +47,7 @@

    Coverage report:

    coverage.py v6.5.0, - created at 2023-05-10 20:51 +0100 + created at 2023-10-26 21:13 +0100

    @@ -104,7 +104,7 @@

    Coverage report:

    coverage.py v6.5.0, - created at 2023-05-10 20:51 +0100 + created at 2023-10-26 21:13 +0100

    dxf.DXFBase(host[, auth, insecure, ...])