Skip to content

webknossos.client.generated.client

#   class Client:

A class for keeping track of data related to the API

#   Client( base_url: str, *, cookies: Dict[str, str] = NOTHING, headers: Dict[str, str] = NOTHING, timeout: float = 5.0 )

Method generated by attrs for class Client.

#   def get_headers(self) -> Dict[str, str]:

Get headers to be used in all endpoints

#   def with_headers( self, headers: Dict[str, str] ) -> webknossos.client.generated.client.Client:

Get a new client matching this one with additional headers

#   def get_cookies(self) -> Dict[str, str]:
#   def with_cookies( self, cookies: Dict[str, str] ) -> webknossos.client.generated.client.Client:

Get a new client matching this one with additional cookies

#   def get_timeout(self) -> float:
#   def with_timeout(self, timeout: float) -> webknossos.client.generated.client.Client:

Get a new client matching this one with a new timeout (in seconds)

#   class AuthenticatedClient(Client):

A Client which has been authenticated for use on secured endpoints

#   AuthenticatedClient( base_url: str, token: str, *, cookies: Dict[str, str] = NOTHING, headers: Dict[str, str] = NOTHING, timeout: float = 5.0 )

Method generated by attrs for class AuthenticatedClient.

#   def get_headers(self) -> Dict[str, str]:

Get headers to be used in authenticated endpoints

Back to top