Module python_odpt.types

Contains some shared types for properties

Classes

class File (payload: ,
file_name: str | None = None,
mime_type: str | None = None)

Expand source code

@define
class File:
    """Contains information for file uploads"""

    payload: BinaryIO
    file_name: Optional[str] = None
    mime_type: Optional[str] = None

    def to_tuple(self) -> FileJsonType:
        """Return a tuple representation that httpx will accept for multipart/form-data"""
        return self.file_name, self.payload, self.mime_type

Contains information for file uploads

Method generated by attrs for class File.

Instance variables

var file_name : str | None

Expand source code

@define
class File:
    """Contains information for file uploads"""

    payload: BinaryIO
    file_name: Optional[str] = None
    mime_type: Optional[str] = None

    def to_tuple(self) -> FileJsonType:
        """Return a tuple representation that httpx will accept for multipart/form-data"""
        return self.file_name, self.payload, self.mime_type

var mime_type : str | None

Expand source code

@define
class File:
    """Contains information for file uploads"""

    payload: BinaryIO
    file_name: Optional[str] = None
    mime_type: Optional[str] = None

    def to_tuple(self) -> FileJsonType:
        """Return a tuple representation that httpx will accept for multipart/form-data"""
        return self.file_name, self.payload, self.mime_type

var payload : 

Expand source code

@define
class File:
    """Contains information for file uploads"""

    payload: BinaryIO
    file_name: Optional[str] = None
    mime_type: Optional[str] = None

    def to_tuple(self) -> FileJsonType:
        """Return a tuple representation that httpx will accept for multipart/form-data"""
        return self.file_name, self.payload, self.mime_type

Methods

def to_tuple(self) ‑> Tuple[str | None, BinaryIO, str | None]

Expand source code

def to_tuple(self) -> FileJsonType:
    """Return a tuple representation that httpx will accept for multipart/form-data"""
    return self.file_name, self.payload, self.mime_type

Return a tuple representation that httpx will accept for multipart/form-data

class Response (status_code: http.HTTPStatus,
content: bytes,
headers: MutableMapping[str, str],
parsed: ~T | None)

Expand source code

@define
class Response(Generic[T]):
    """A response from an endpoint"""

    status_code: HTTPStatus
    content: bytes
    headers: MutableMapping[str, str]
    parsed: Optional[T]

A response from an endpoint

Method generated by attrs for class Response.

Ancestors

• typing.Generic

Instance variables

var content : bytes

Expand source code

@define
class Response(Generic[T]):
    """A response from an endpoint"""

    status_code: HTTPStatus
    content: bytes
    headers: MutableMapping[str, str]
    parsed: Optional[T]

var headers : MutableMapping[str, str]

Expand source code

@define
class Response(Generic[T]):
    """A response from an endpoint"""

    status_code: HTTPStatus
    content: bytes
    headers: MutableMapping[str, str]
    parsed: Optional[T]

var parsed : ~T | None

Expand source code

@define
class Response(Generic[T]):
    """A response from an endpoint"""

    status_code: HTTPStatus
    content: bytes
    headers: MutableMapping[str, str]
    parsed: Optional[T]

var status_code : http.HTTPStatus

Expand source code

@define
class Response(Generic[T]):
    """A response from an endpoint"""

    status_code: HTTPStatus
    content: bytes
    headers: MutableMapping[str, str]
    parsed: Optional[T]

class Unset

Expand source code

class Unset:
    def __bool__(self) -> Literal[False]:
        return False