k8s.base module

exception k8s.base.APIServerError(api_error)

Bases: Exception

Raised when the API server returns an error event in the watch stream

classmethod match(event_json)

class k8s.base.ApiMixIn

Bases: object

ApiMixIn class for top level Models

Contains methods for working with the API

classmethod delete(name, namespace='default', **kwargs)

Delete the named resource

classmethod delete_list(namespace='default', labels=None, delete_options=None, **kwargs)

classmethod find(name='', namespace='default', labels=None)

Find resources using label selection

Param:

str name: The name of the resource, as indicated by the app label

Param:

str namespace: The namespace to search in

Param:

dict labels: More advanced label selection (see below)

Returns:

A list of matching objects

When a labels dictionary is supplied, the name parameter is ignored. See the docs for _label_selector for more details

classmethod get(name, namespace='default')

Get from API server if it exists

classmethod get_or_create(**kwargs)

If exists, get from API, else create new instance

classmethod list(namespace='default')

List all resources in given namespace

classmethod list_with_meta(namespace='default')

List all resources in given namespace. Return ModelList

save()

Save to API server, either update if existing, or create if new

save_status()

Save status to API server, always updating

classmethod watch_list(namespace=None, resource_version=None, allow_bookmarks=False)

Return a generator that yields WatchEvents of cls. If allowBookmarks is True, WatchBookmarks will also be yielded. It’s recommended to use the Watcher class instead of calling this directly, since it handles reconnects and resource versions.

class k8s.base.Equality(value='')

Bases: LabelSelector

operator = '='

Operator used in selection query

class k8s.base.Exists

Bases: LabelSelector

class k8s.base.In(value='')

Bases: LabelSetSelector

operator = 'in'

Operator used in selection query

class k8s.base.Inequality(value='')

Bases: LabelSelector

operator = '!='

Operator used in selection query

class k8s.base.LabelSelector(value='')

Bases: object

Base for label select operations

operator = None

Operator used in selection query

class k8s.base.LabelSetSelector(value='')

Bases: LabelSelector

class k8s.base.ListMeta(new=True, **kwargs)

Bases: Model

remainingItemCount

Generic field on a k8s model

resourceVersion

Generic field on a k8s model

class k8s.base.MetaModel(cls, bases, attrs)

Bases: type

Metaclass for Model

Responsibilities:

• Creating the _meta attribute, with url_template (if present), list of fields and for convenience, a list of field names.

• Creates properties for name and namespace if the instance has a metadata field.

• Mixes in ApiMixIn if the Model has a Meta attribute, indicating a top level Model (not to be confused with _meta).

class k8s.base.Model(new=True, **kwargs)

Bases: object

A kubernetes Model object

Contains fields for each attribute in the API specification, and methods for export/import.

as_dict()

classmethod from_dict(d)

merge(other)

merge sets each field in self to the value provided by other This is mostly equivalent to just replacing self with other, except read only fields in self are preserved.

update(other)

merge sets each field in self to the value provided by other This is mostly equivalent to just replacing self with other, except read only fields in self are preserved.

update_from_dict(d)

class k8s.base.ModelList(metadata: ListMeta, items: List[Model])

Bases: object

Generic type to hold list of Model instances (items) together with ListMeta (metadata), as returned by list API calls

classmethod from_dict(model_cls: type[Model], list_response_data: Dict)

class k8s.base.NotIn(value='')

Bases: LabelSetSelector

operator = 'notin'

Operator used in selection query

class k8s.base.SelfModel

Bases: object

Use SelfModel as Field.type to set Field.type to the model the Field was defined in during model instantiation.

This allows models to have fields with their own type. It is not possible to reference a class in its own attributes.

Example: ``` class MyModel(Model):

submodel = Field(SelfModel) # submodel gets the type MyModel

```

class k8s.base.SyntheticAddedWatchEvent(obj: Model)

Bases: WatchEvent

resource_version

class k8s.base.WatchBaseEvent(event_json=None, resource_version=None)

Bases: ABC

Abstract base class for Watch events. Contains the resource version of the event as property resource_version.

has_object()

resource_version

class k8s.base.WatchBookmark(event_json)

Bases: WatchBaseEvent

Bookmark events, if enabled, are sent periodically by the API server. They only contain the resourceVersion of the event.

has_object()

classmethod match(event_json)

resource_version

class k8s.base.WatchEvent(event_json: dict | None = None, cls: type[Model] | None = None, _type: str | None = None, _object: Model | None = None)

Bases: WatchBaseEvent

ADDED = 'ADDED'

DELETED = 'DELETED'

MODIFIED = 'MODIFIED'

has_object()

resource_version