in2lambda.api.visibility_status.VisibilityController¶

class in2lambda.api.visibility_status.VisibilityController(initial_status: VisibilityStatus = OPEN)[source]¶

Bases: object

Controller for managing visibility status with easy-to-use methods.

__init__(initial_status: VisibilityStatus = OPEN)[source]¶

Initialize the VisibilityController with a specific status.

Methods

__init__([initial_status])

Initialize the VisibilityController with a specific status.

to_dict()

Convert VisibilityController to dictionary for JSON serialization.

to_hide()

Change status to HIDE.

to_open()

Change status to OPEN.

to_open_with_warnings()

Change status to OPEN_WITH_WARNINGS.

Attributes

status

Return the current visibility status.

property status: VisibilityStatus¶

Return the current visibility status.

to_dict()[source]¶

Convert VisibilityController to dictionary for JSON serialization.

to_hide()[source]¶

Change status to HIDE.

Example

>>> vc = VisibilityController()
>>> vc.to_hide()
>>> vc.status
HIDE
to_open()[source]¶

Change status to OPEN.

Example

>>> vc = VisibilityController()
>>> vc.to_open()
>>> vc.status
OPEN
to_open_with_warnings()[source]¶

Change status to OPEN_WITH_WARNINGS.

Example

>>> vc = VisibilityController()
>>> vc.to_open_with_warnings()
>>> vc.status
OPEN_WITH_WARNINGS