kittycad.types
index
/home/runner/work/kittycad.py/kittycad.py/kittycad/types.py

Contains some shared types for properties

 
Modules
       
attr

 
Classes
       
builtins.object
File
typing.Generic(builtins.object)
Response

 
class File(builtins.object)
    File(payload: Union[BinaryIO, TextIO], file_name: Optional[str] = None, mime_type: Optional[str] = None) -> None
 
Contains information for file uploads
 
  Methods defined here:
__eq__(self, other)
Method generated by attrs for class File.
__ge__(self, other)
Method generated by attrs for class File.
__gt__(self, other)
Method generated by attrs for class File.
__init__(self, payload: Union[BinaryIO, TextIO], file_name: Optional[str] = None, mime_type: Optional[str] = None) -> None
Method generated by attrs for class File.
__le__(self, other)
Method generated by attrs for class File.
__lt__(self, other)
Method generated by attrs for class File.
__ne__(self, other)
Method generated by attrs for class File.
__repr__(self)
Method generated by attrs for class File.
to_tuple(self) -> Tuple[Optional[str], Union[BinaryIO, TextIO], Optional[str]]
Return a tuple representation that httpx will accept for multipart/form-data

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

Data and other attributes defined here:
__annotations__ = {'file_name': typing.Optional[str], 'mime_type': typing.Optional[str], 'payload': typing.Union[typing.BinaryIO, typing.TextIO]}
__attrs_attrs__ = (Attribute(name='payload', default=NOTHING, vali...kw_only=False, inherited=False, on_setattr=None))
__hash__ = None

 
class Response(typing.Generic)
    Response(status_code: int, content: bytes, headers: MutableMapping[str, str], parsed: Optional[~T]) -> None
 
A response from an endpoint
 
 
Method resolution order:
Response
typing.Generic
builtins.object

Methods defined here:
__eq__(self, other)
Method generated by attrs for class Response.
__ge__(self, other)
Method generated by attrs for class Response.
__gt__(self, other)
Method generated by attrs for class Response.
__init__(self, status_code: int, content: bytes, headers: MutableMapping[str, str], parsed: Optional[~T]) -> None
Method generated by attrs for class Response.
__le__(self, other)
Method generated by attrs for class Response.
__lt__(self, other)
Method generated by attrs for class Response.
__ne__(self, other)
Method generated by attrs for class Response.
__repr__(self)
Method generated by attrs for class Response.

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

Data and other attributes defined here:
__annotations__ = {'content': <class 'bytes'>, 'headers': typing.MutableMapping[str, str], 'parsed': typing.Optional[~T], 'status_code': <class 'int'>}
__attrs_attrs__ = (Attribute(name='status_code', default=NOTHING, ...kw_only=False, inherited=False, on_setattr=None))
__hash__ = None
__orig_bases__ = (typing.Generic[~T],)
__parameters__ = (~T,)

Class methods inherited from typing.Generic:
__class_getitem__(params) from builtins.type
__init_subclass__(*args, **kwargs) from builtins.type
This method is called when a class is subclassed.
 
The default implementation does nothing. It may be
overridden to extend subclasses.

 
Data
        FileJsonType = typing.Tuple[typing.Optional[str], typing.Union[...g.BinaryIO, typing.TextIO], typing.Optional[str]]
__all__ = ['File', 'Response', 'FileJsonType']
__annotations__ = {'UNSET': <class 'kittycad.types.Unset'>}