Base¶

Just another Python API for Travis CI (API).

A module which provides the base of all our resource type objects.

Author:: Nissar Chababy, @funilrys, contactTATAfunilrysTODTODcom
Project link:: https://github.com/funilrys/PyTravisCI
Project documentation:: https://pytravisci.readthedocs.io/en/latest/

License

MIT License

Copyright (c) 2019, 2020, 2021, 2022 Nissar Chababy

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

class PyTravisCI.resource_types.base.ComplexJsonEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)[source]¶

Provides ours complex JSON encoder.

default(o: Any)[source]¶: Implements our complex conversion to JSON.

class PyTravisCI.resource_types.base.ResourceTypesBase(**kwargs)[source]¶

The base of all ressource types.

dict(*, remove_tags: bool = False) → str[source]¶: Alias of to_dict.

first_page() → Optional[PyTravisCI.resource_types.base.ResourceTypesBase][source]¶

Provides the first page.

Raises:	FirstPageNotFound – If the first page was not found.

get_complete() → Optional[PyTravisCI.resource_types.base.ResourceTypesBase][source]¶: Provides the complete representation if the current representation is the minimal one.

has_first_page() → bool[source]¶: Checks if there is a first page to follow.

has_last_page() → bool[source]¶: Checks if there is a last page to follow.

has_next_page() → bool[source]¶: Checks if there is a next page to follow.

has_previous_page() → bool[source]¶: Checks if there is a previous page to follow.

is_incomplete() → bool[source]¶

Checks if the current object is incomplete.

An object is consired as incomplete if its representation is minimal.

json(*, remove_tags: bool = False) → str[source]¶: Alias of to_json.

last_page() → Optional[PyTravisCI.resource_types.base.ResourceTypesBase][source]¶

Provides the last page.

Raises:	LastPageNotFound – If the last page was not found.

next_page() → Optional[PyTravisCI.resource_types.base.ResourceTypesBase][source]¶

Provides the next page.

Raises:	NextPageNotFound – If the next page was not found.

previous_page() → Optional[PyTravisCI.resource_types.base.ResourceTypesBase][source]¶

Provides the previous page.

Raises:	PreviousPageNotFound – If the previous page was not found.

to_dict(*, remove_tags: bool = False) → PyTravisCI.resource_types.base.ResourceTypesBase.dict[source]¶

Converts the current object to dict.

Parameters:	remove_tags – Remove all `@tags` and everything related to PyTravisCI.

to_json(*, remove_tags: bool = False) → str[source]¶

Converts the current object to json.

Parameters:	remove_tags – Remove all `@tags` and everything related to PyTravisCI.