chris.client.anon 

 1from typing import Optional
 2
 3import aiohttp
 4
 5from chris.client.base import BaseChrisClient
 6from chris.link import http
 7from chris.models.collection_links import AnonymousCollectionLinks
 8from chris.models.public import PublicPlugin
 9from chris.util.search import Search
10
11
12class AnonChrisClient(BaseChrisClient[AnonymousCollectionLinks, "AnonChrisClient"]):
13    """
14    An anonymous ChRIS client. It has access to read-only GET resources,
15    such as being able to search for plugins.
16    """
17
18    @classmethod
19    async def from_url(
20        cls,
21        url: str,
22        max_search_requests: int = 100,
23        connector: Optional[aiohttp.BaseConnector] = None,
24        connector_owner: bool = True,
25    ) -> "AnonChrisClient":
26        """
27        Create an anonymous client.
28
29        See `chris.client.base.BaseChrisClient.new` for parameter documentation.
30        """
31        return await cls.new(
32            url=url,
33            max_search_requests=max_search_requests,
34            connector=connector,
35            connector_owner=connector_owner,
36        )
37
38    @http.search("plugins")
39    def search_plugins(self, **query) -> Search[PublicPlugin]:
40        """
41        Search for plugins.
42
43        Since this client is not logged in, you cannot create plugin instances using this client.
44        """
45        ...
class AnonChrisClient(chris.client.base.BaseChrisClient[chris.models.collection_links.AnonymousCollectionLinks, 'AnonChrisClient']): 
13class AnonChrisClient(BaseChrisClient[AnonymousCollectionLinks, "AnonChrisClient"]):
14    """
15    An anonymous ChRIS client. It has access to read-only GET resources,
16    such as being able to search for plugins.
17    """
18
19    @classmethod
20    async def from_url(
21        cls,
22        url: str,
23        max_search_requests: int = 100,
24        connector: Optional[aiohttp.BaseConnector] = None,
25        connector_owner: bool = True,
26    ) -> "AnonChrisClient":
27        """
28        Create an anonymous client.
29
30        See `chris.client.base.BaseChrisClient.new` for parameter documentation.
31        """
32        return await cls.new(
33            url=url,
34            max_search_requests=max_search_requests,
35            connector=connector,
36            connector_owner=connector_owner,
37        )
38
39    @http.search("plugins")
40    def search_plugins(self, **query) -> Search[PublicPlugin]:
41        """
42        Search for plugins.
43
44        Since this client is not logged in, you cannot create plugin instances using this client.
45        """
46        ...

An anonymous ChRIS client. It has access to read-only GET resources, such as being able to search for plugins.

@classmethod
async def from_url( cls, url: str, max_search_requests: int = 100, connector: Optional[aiohttp.connector.BaseConnector] = None, connector_owner: bool = True) -> chris.client.anon.AnonChrisClient: 
19    @classmethod
20    async def from_url(
21        cls,
22        url: str,
23        max_search_requests: int = 100,
24        connector: Optional[aiohttp.BaseConnector] = None,
25        connector_owner: bool = True,
26    ) -> "AnonChrisClient":
27        """
28        Create an anonymous client.
29
30        See `chris.client.base.BaseChrisClient.new` for parameter documentation.
31        """
32        return await cls.new(
33            url=url,
34            max_search_requests=max_search_requests,
35            connector=connector,
36            connector_owner=connector_owner,
37        )

Create an anonymous client.

See chris.client.base.BaseChrisClient.new for parameter documentation.

@http.search('plugins')
def search_plugins( self, **query) -> chris.util.search.Search[chris.models.public.PublicPlugin]: 
39    @http.search("plugins")
40    def search_plugins(self, **query) -> Search[PublicPlugin]:
41        """
42        Search for plugins.
43
44        Since this client is not logged in, you cannot create plugin instances using this client.
45        """
46        ...

Search for plugins.

Since this client is not logged in, you cannot create plugin instances using this client.

Inherited Members
chris.link.collection_client.CollectionJsonApiClient
CollectionJsonApiClient
url
chris.client.base.BaseChrisClient
new
close
chris.link.linked.Linked
max_search_requests