Skip to content

omnipy.shared.enums.ui

User interface enums for environment detection, capabilities, and output targets.

CLASS DESCRIPTION
AutoDetectableUserInterfaceType

User interface types that Omnipy can detect automatically.
BrowserPageUserInterfaceType

Browser UI enum values that render full HTML pages.
BrowserTagUserInterfaceType

Browser UI enum values that render embeddable HTML fragments.
BrowserUserInterfaceType

Browser UI enum values for page-based and tag-based output.
HtmlPageOutputUserInterfaceType

UI enum values that require full HTML page output.
HtmlTagOutputUserInterfaceType

UI enum values that require self-contained HTML tag output.
IpythonEmbeddedTerminalUserInterfaceType

IPython terminal UI enum values embedded inside another application.
IpythonTerminalUserInterfaceType

IPython terminal UI enum values supported by Omnipy.
JupyterEmbeddedUserInterfaceType

Embedded Jupyter UI enum values, such as notebooks inside IDEs.
JupyterInBrowserUserInterfaceType

Browser-hosted Jupyter UI enum values.
JupyterUserInterfaceType

Jupyter UI enum values for embedded and browser-hosted notebooks.
PlainTerminalEmbeddedUserInterfaceType

Plain terminal UI enum values embedded inside another application.
PlainTerminalUserInterfaceType

Plain terminal UI enum values supported by Omnipy.
RgbColorUserInterfaceType

UI enum values that support RGB color output.
SpecifiedUserInterfaceType

User interface types represented as explicit concrete UI values.
SupportsDarkTerminalBgDetection

UI enum values that support dark terminal background detection.
TerminalOutputUserInterfaceType

UI enum values that require ANSI terminal output.
TerminalUserInterfaceType

Terminal UI enum values covering plain and IPython terminals.
UserInterfaceType

Describe the interface type used for Omnipy interaction and output.

AutoDetectableUserInterfaceType

Bases: PlainTerminalUserInterfaceType, IpythonTerminalUserInterfaceType, JupyterUserInterfaceType


              flowchart BT
              omnipy.shared.enums.ui.AutoDetectableUserInterfaceType[AutoDetectableUserInterfaceType]
              omnipy.shared.enums.ui.PlainTerminalUserInterfaceType[PlainTerminalUserInterfaceType]
              omnipy.shared.enums.ui.PlainTerminalEmbeddedUserInterfaceType[PlainTerminalEmbeddedUserInterfaceType]
              omnipy.shared.enums.ui.IpythonTerminalUserInterfaceType[IpythonTerminalUserInterfaceType]
              omnipy.shared.enums.ui.IpythonEmbeddedTerminalUserInterfaceType[IpythonEmbeddedTerminalUserInterfaceType]
              omnipy.shared.enums.ui.JupyterUserInterfaceType[JupyterUserInterfaceType]
              omnipy.shared.enums.ui.JupyterEmbeddedUserInterfaceType[JupyterEmbeddedUserInterfaceType]
              omnipy.shared.enums.ui.JupyterInBrowserUserInterfaceType[JupyterInBrowserUserInterfaceType]
              omnipy.util.literal_enum.LiteralEnum[LiteralEnum]

                              omnipy.shared.enums.ui.PlainTerminalUserInterfaceType --> omnipy.shared.enums.ui.AutoDetectableUserInterfaceType
                                omnipy.shared.enums.ui.PlainTerminalEmbeddedUserInterfaceType --> omnipy.shared.enums.ui.PlainTerminalUserInterfaceType
                                omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.PlainTerminalEmbeddedUserInterfaceType
                

                omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.PlainTerminalUserInterfaceType
                

                omnipy.shared.enums.ui.IpythonTerminalUserInterfaceType --> omnipy.shared.enums.ui.AutoDetectableUserInterfaceType
                                omnipy.shared.enums.ui.IpythonEmbeddedTerminalUserInterfaceType --> omnipy.shared.enums.ui.IpythonTerminalUserInterfaceType
                                omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.IpythonEmbeddedTerminalUserInterfaceType
                

                omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.IpythonTerminalUserInterfaceType
                

                omnipy.shared.enums.ui.JupyterUserInterfaceType --> omnipy.shared.enums.ui.AutoDetectableUserInterfaceType
                                omnipy.shared.enums.ui.JupyterEmbeddedUserInterfaceType --> omnipy.shared.enums.ui.JupyterUserInterfaceType
                                omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.JupyterEmbeddedUserInterfaceType
                

                omnipy.shared.enums.ui.JupyterInBrowserUserInterfaceType --> omnipy.shared.enums.ui.JupyterUserInterfaceType
                                omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.JupyterInBrowserUserInterfaceType
                




              click omnipy.shared.enums.ui.AutoDetectableUserInterfaceType href "" "omnipy.shared.enums.ui.AutoDetectableUserInterfaceType"
              click omnipy.shared.enums.ui.PlainTerminalUserInterfaceType href "" "omnipy.shared.enums.ui.PlainTerminalUserInterfaceType"
              click omnipy.shared.enums.ui.PlainTerminalEmbeddedUserInterfaceType href "" "omnipy.shared.enums.ui.PlainTerminalEmbeddedUserInterfaceType"
              click omnipy.shared.enums.ui.IpythonTerminalUserInterfaceType href "" "omnipy.shared.enums.ui.IpythonTerminalUserInterfaceType"
              click omnipy.shared.enums.ui.IpythonEmbeddedTerminalUserInterfaceType href "" "omnipy.shared.enums.ui.IpythonEmbeddedTerminalUserInterfaceType"
              click omnipy.shared.enums.ui.JupyterUserInterfaceType href "" "omnipy.shared.enums.ui.JupyterUserInterfaceType"
              click omnipy.shared.enums.ui.JupyterEmbeddedUserInterfaceType href "" "omnipy.shared.enums.ui.JupyterEmbeddedUserInterfaceType"
              click omnipy.shared.enums.ui.JupyterInBrowserUserInterfaceType href "" "omnipy.shared.enums.ui.JupyterInBrowserUserInterfaceType"
              click omnipy.util.literal_enum.LiteralEnum href "" "omnipy.util.literal_enum.LiteralEnum"

User interface types that Omnipy can detect automatically.

User interface types that can be automatically detected by Omnipy, based on the environment in which the code is running.

Returned by:
ATTRIBUTE DESCRIPTION
Literals

Source code in src/omnipy/shared/enums/ui.py 
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
class AutoDetectableUserInterfaceType(
        PlainTerminalUserInterfaceType,
        IpythonTerminalUserInterfaceType,
        JupyterUserInterfaceType,
):
    """User interface types that Omnipy can detect automatically.

    User interface types that can be automatically detected by Omnipy, based
    on the environment in which the code is running.
    """

    Literals = Literal[
        PlainTerminalUserInterfaceType.Literals,
        IpythonTerminalUserInterfaceType.Literals,
        JupyterUserInterfaceType.Literals,
    ]

Literals class-attribute instance-attribute 

Literals = Literal[
    PlainTerminalUserInterfaceType.Literals,
    IpythonTerminalUserInterfaceType.Literals,
    JupyterUserInterfaceType.Literals,
]
Returned by:

BrowserPageUserInterfaceType

Bases: LiteralEnum[str]


              flowchart BT
              omnipy.shared.enums.ui.BrowserPageUserInterfaceType[BrowserPageUserInterfaceType]
              omnipy.util.literal_enum.LiteralEnum[LiteralEnum]

                              omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.BrowserPageUserInterfaceType
                


              click omnipy.shared.enums.ui.BrowserPageUserInterfaceType href "" "omnipy.shared.enums.ui.BrowserPageUserInterfaceType"
              click omnipy.util.literal_enum.LiteralEnum href "" "omnipy.util.literal_enum.LiteralEnum"

Browser UI enum values that render full HTML pages.

Subclassed by: Used by:
ATTRIBUTE DESCRIPTION
BROWSER_PAGE

TYPE: Literal['browser-page']

Literals

Source code in src/omnipy/shared/enums/ui.py 
170
171
172
173
174
175
176
177
178
179
180
class BrowserPageUserInterfaceType(LiteralEnum[str]):
    """Browser UI enum values that render full HTML pages."""

    Literals = Literal['browser-page']

    BROWSER_PAGE: Literal['browser-page'] = 'browser-page'
    f"""Browser UI for full-page HTML output.

    {_BROWSER_DESCRIPTION} The `BROWSER_PAGE` UI type displays content as
    full web pages.
    """

BROWSER_PAGE class-attribute instance-attribute 

BROWSER_PAGE: Literal['browser-page'] = 'browser-page'

Literals class-attribute instance-attribute 

Literals = Literal['browser-page']
Used by:

BrowserTagUserInterfaceType

Bases: LiteralEnum[str]


              flowchart BT
              omnipy.shared.enums.ui.BrowserTagUserInterfaceType[BrowserTagUserInterfaceType]
              omnipy.util.literal_enum.LiteralEnum[LiteralEnum]

                              omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.BrowserTagUserInterfaceType
                


              click omnipy.shared.enums.ui.BrowserTagUserInterfaceType href "" "omnipy.shared.enums.ui.BrowserTagUserInterfaceType"
              click omnipy.util.literal_enum.LiteralEnum href "" "omnipy.util.literal_enum.LiteralEnum"

Browser UI enum values that render embeddable HTML fragments.

Subclassed by: Used by:
ATTRIBUTE DESCRIPTION
BROWSER_TAG

TYPE: Literal['browser-tag']

Literals

Source code in src/omnipy/shared/enums/ui.py 
183
184
185
186
187
188
189
190
191
192
193
194
class BrowserTagUserInterfaceType(LiteralEnum[str]):
    """Browser UI enum values that render embeddable HTML fragments."""

    Literals = Literal['browser-tag']

    BROWSER_TAG: Literal['browser-tag'] = 'browser-tag'
    f"""Browser UI for embeddable HTML fragment output.

    {_BROWSER_DESCRIPTION} The `BROWSER_TAG` UI type displays content as
    standalone HTML elements, for HTML code that can be embedded in other
    HTML documents.
    """

BROWSER_TAG class-attribute instance-attribute 

BROWSER_TAG: Literal['browser-tag'] = 'browser-tag'

Literals class-attribute instance-attribute 

Literals = Literal['browser-tag']
Used by:

BrowserUserInterfaceType

Bases: BrowserPageUserInterfaceType, BrowserTagUserInterfaceType


              flowchart BT
              omnipy.shared.enums.ui.BrowserUserInterfaceType[BrowserUserInterfaceType]
              omnipy.shared.enums.ui.BrowserPageUserInterfaceType[BrowserPageUserInterfaceType]
              omnipy.shared.enums.ui.BrowserTagUserInterfaceType[BrowserTagUserInterfaceType]
              omnipy.util.literal_enum.LiteralEnum[LiteralEnum]

                              omnipy.shared.enums.ui.BrowserPageUserInterfaceType --> omnipy.shared.enums.ui.BrowserUserInterfaceType
                                omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.BrowserPageUserInterfaceType
                

                omnipy.shared.enums.ui.BrowserTagUserInterfaceType --> omnipy.shared.enums.ui.BrowserUserInterfaceType
                                omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.BrowserTagUserInterfaceType
                



              click omnipy.shared.enums.ui.BrowserUserInterfaceType href "" "omnipy.shared.enums.ui.BrowserUserInterfaceType"
              click omnipy.shared.enums.ui.BrowserPageUserInterfaceType href "" "omnipy.shared.enums.ui.BrowserPageUserInterfaceType"
              click omnipy.shared.enums.ui.BrowserTagUserInterfaceType href "" "omnipy.shared.enums.ui.BrowserTagUserInterfaceType"
              click omnipy.util.literal_enum.LiteralEnum href "" "omnipy.util.literal_enum.LiteralEnum"

Browser UI enum values for page-based and tag-based output.

Returned by: Subclassed by: Used by:
ATTRIBUTE DESCRIPTION
Literals

Source code in src/omnipy/shared/enums/ui.py 
197
198
199
200
class BrowserUserInterfaceType(BrowserPageUserInterfaceType, BrowserTagUserInterfaceType):
    """Browser UI enum values for page-based and tag-based output."""

    Literals = Literal[BrowserPageUserInterfaceType.Literals, BrowserTagUserInterfaceType.Literals]

Literals class-attribute instance-attribute 

Literals = Literal[BrowserPageUserInterfaceType.Literals, BrowserTagUserInterfaceType.Literals]
Returned by: Used by:

HtmlPageOutputUserInterfaceType

Bases: BrowserPageUserInterfaceType


              flowchart BT
              omnipy.shared.enums.ui.HtmlPageOutputUserInterfaceType[HtmlPageOutputUserInterfaceType]
              omnipy.shared.enums.ui.BrowserPageUserInterfaceType[BrowserPageUserInterfaceType]
              omnipy.util.literal_enum.LiteralEnum[LiteralEnum]

                              omnipy.shared.enums.ui.BrowserPageUserInterfaceType --> omnipy.shared.enums.ui.HtmlPageOutputUserInterfaceType
                                omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.BrowserPageUserInterfaceType
                



              click omnipy.shared.enums.ui.HtmlPageOutputUserInterfaceType href "" "omnipy.shared.enums.ui.HtmlPageOutputUserInterfaceType"
              click omnipy.shared.enums.ui.BrowserPageUserInterfaceType href "" "omnipy.shared.enums.ui.BrowserPageUserInterfaceType"
              click omnipy.util.literal_enum.LiteralEnum href "" "omnipy.util.literal_enum.LiteralEnum"

UI enum values that require full HTML page output.

Returned by:
ATTRIBUTE DESCRIPTION
Literals

Source code in src/omnipy/shared/enums/ui.py 
243
244
245
246
class HtmlPageOutputUserInterfaceType(BrowserPageUserInterfaceType):
    """UI enum values that require full HTML page output."""

    Literals = Literal[BrowserPageUserInterfaceType.Literals]

Literals class-attribute instance-attribute 

Literals = Literal[BrowserPageUserInterfaceType.Literals]
Returned by:

HtmlTagOutputUserInterfaceType

Bases: JupyterInBrowserUserInterfaceType, BrowserTagUserInterfaceType


              flowchart BT
              omnipy.shared.enums.ui.HtmlTagOutputUserInterfaceType[HtmlTagOutputUserInterfaceType]
              omnipy.shared.enums.ui.JupyterInBrowserUserInterfaceType[JupyterInBrowserUserInterfaceType]
              omnipy.shared.enums.ui.BrowserTagUserInterfaceType[BrowserTagUserInterfaceType]
              omnipy.util.literal_enum.LiteralEnum[LiteralEnum]

                              omnipy.shared.enums.ui.JupyterInBrowserUserInterfaceType --> omnipy.shared.enums.ui.HtmlTagOutputUserInterfaceType
                                omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.JupyterInBrowserUserInterfaceType
                

                omnipy.shared.enums.ui.BrowserTagUserInterfaceType --> omnipy.shared.enums.ui.HtmlTagOutputUserInterfaceType
                                omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.BrowserTagUserInterfaceType
                



              click omnipy.shared.enums.ui.HtmlTagOutputUserInterfaceType href "" "omnipy.shared.enums.ui.HtmlTagOutputUserInterfaceType"
              click omnipy.shared.enums.ui.JupyterInBrowserUserInterfaceType href "" "omnipy.shared.enums.ui.JupyterInBrowserUserInterfaceType"
              click omnipy.shared.enums.ui.BrowserTagUserInterfaceType href "" "omnipy.shared.enums.ui.BrowserTagUserInterfaceType"
              click omnipy.util.literal_enum.LiteralEnum href "" "omnipy.util.literal_enum.LiteralEnum"

UI enum values that require self-contained HTML tag output.

Returned by:
ATTRIBUTE DESCRIPTION
Literals

Source code in src/omnipy/shared/enums/ui.py 
231
232
233
234
235
236
237
238
239
240
class HtmlTagOutputUserInterfaceType(
        JupyterInBrowserUserInterfaceType,
        BrowserTagUserInterfaceType,
):
    """UI enum values that require self-contained HTML tag output."""

    Literals = Literal[
        JupyterInBrowserUserInterfaceType.Literals,
        BrowserTagUserInterfaceType.Literals,
    ]

Literals class-attribute instance-attribute 

Literals = Literal[JupyterInBrowserUserInterfaceType.Literals, BrowserTagUserInterfaceType.Literals]
Returned by:

IpythonEmbeddedTerminalUserInterfaceType

Bases: LiteralEnum[str]


              flowchart BT
              omnipy.shared.enums.ui.IpythonEmbeddedTerminalUserInterfaceType[IpythonEmbeddedTerminalUserInterfaceType]
              omnipy.util.literal_enum.LiteralEnum[LiteralEnum]

                              omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.IpythonEmbeddedTerminalUserInterfaceType
                


              click omnipy.shared.enums.ui.IpythonEmbeddedTerminalUserInterfaceType href "" "omnipy.shared.enums.ui.IpythonEmbeddedTerminalUserInterfaceType"
              click omnipy.util.literal_enum.LiteralEnum href "" "omnipy.util.literal_enum.LiteralEnum"

IPython terminal UI enum values embedded inside another application.

Subclassed by: Used by:
ATTRIBUTE DESCRIPTION
Literals

PYCHARM_IPYTHON

TYPE: Literal['pycharm_ipython']

Source code in src/omnipy/shared/enums/ui.py 
84
85
86
87
88
89
90
91
92
93
94
95
class IpythonEmbeddedTerminalUserInterfaceType(LiteralEnum[str]):
    """IPython terminal UI enum values embedded inside another application."""

    Literals = Literal['pycharm_ipython']

    PYCHARM_IPYTHON: Literal['pycharm_ipython'] = 'pycharm_ipython'
    f"""PyCharm terminal running the IPython REPL.

    The console and/or terminal of the JetBrains PyCharm IDE running with
    the IPython interactive interpreter (REPL).
     {_IPYTHON_DESCRIPTION} {_PYCHARM_NOTE}
    """

Literals class-attribute instance-attribute 

Literals = Literal['pycharm_ipython']
Used by:

PYCHARM_IPYTHON class-attribute instance-attribute 

PYCHARM_IPYTHON: Literal['pycharm_ipython'] = 'pycharm_ipython'

IpythonTerminalUserInterfaceType

Bases: IpythonEmbeddedTerminalUserInterfaceType, LiteralEnum[str]


              flowchart BT
              omnipy.shared.enums.ui.IpythonTerminalUserInterfaceType[IpythonTerminalUserInterfaceType]
              omnipy.shared.enums.ui.IpythonEmbeddedTerminalUserInterfaceType[IpythonEmbeddedTerminalUserInterfaceType]
              omnipy.util.literal_enum.LiteralEnum[LiteralEnum]

                              omnipy.shared.enums.ui.IpythonEmbeddedTerminalUserInterfaceType --> omnipy.shared.enums.ui.IpythonTerminalUserInterfaceType
                                omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.IpythonEmbeddedTerminalUserInterfaceType
                

                omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.IpythonTerminalUserInterfaceType
                


              click omnipy.shared.enums.ui.IpythonTerminalUserInterfaceType href "" "omnipy.shared.enums.ui.IpythonTerminalUserInterfaceType"
              click omnipy.shared.enums.ui.IpythonEmbeddedTerminalUserInterfaceType href "" "omnipy.shared.enums.ui.IpythonEmbeddedTerminalUserInterfaceType"
              click omnipy.util.literal_enum.LiteralEnum href "" "omnipy.util.literal_enum.LiteralEnum"

IPython terminal UI enum values supported by Omnipy.

Returned by: Subclassed by: Used by:
ATTRIBUTE DESCRIPTION
IPYTHON

IPython REPL running in a terminal.

TYPE: Literal['ipython']

Literals

Source code in src/omnipy/shared/enums/ui.py 
 98
 99
100
101
102
103
104
105
106
107
108
109
110
class IpythonTerminalUserInterfaceType(IpythonEmbeddedTerminalUserInterfaceType, LiteralEnum[str]):
    """IPython terminal UI enum values supported by Omnipy."""

    Literals = Literal['ipython', IpythonEmbeddedTerminalUserInterfaceType.Literals]

    IPYTHON: Literal['ipython'] = 'ipython'
    """IPython REPL running in a terminal.

    Same as `TERMINAL`, but running within the IPython interactive
    interpreter (REPL). The IPython interpreter is a more advanced
    interactive interpreter that provides additional features such as syntax
    highlighting, tab completion, and better error messages.
    """

IPYTHON class-attribute instance-attribute 

IPYTHON: Literal['ipython'] = 'ipython'

IPython REPL running in a terminal.

Same as TERMINAL, but running within the IPython interactive interpreter (REPL). The IPython interpreter is a more advanced interactive interpreter that provides additional features such as syntax highlighting, tab completion, and better error messages.

Literals class-attribute instance-attribute 

Literals = Literal['ipython', IpythonEmbeddedTerminalUserInterfaceType.Literals]
Returned by: Used by:

JupyterEmbeddedUserInterfaceType

Bases: LiteralEnum[str]


              flowchart BT
              omnipy.shared.enums.ui.JupyterEmbeddedUserInterfaceType[JupyterEmbeddedUserInterfaceType]
              omnipy.util.literal_enum.LiteralEnum[LiteralEnum]

                              omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.JupyterEmbeddedUserInterfaceType
                


              click omnipy.shared.enums.ui.JupyterEmbeddedUserInterfaceType href "" "omnipy.shared.enums.ui.JupyterEmbeddedUserInterfaceType"
              click omnipy.util.literal_enum.LiteralEnum href "" "omnipy.util.literal_enum.LiteralEnum"

Embedded Jupyter UI enum values, such as notebooks inside IDEs.

Returned by: Subclassed by: Used by:
ATTRIBUTE DESCRIPTION
Literals

PYCHARM_JUPYTER

TYPE: Literal['pycharm_jupyter']

Source code in src/omnipy/shared/enums/ui.py 
122
123
124
125
126
127
128
129
130
131
132
133
class JupyterEmbeddedUserInterfaceType(LiteralEnum[str]):
    """Embedded Jupyter UI enum values, such as notebooks inside IDEs."""

    Literals = Literal['pycharm_jupyter']

    PYCHARM_JUPYTER: Literal['pycharm_jupyter'] = 'pycharm_jupyter'
    f"""PyCharm-hosted Jupyter notebook UI.

    A Jupyter notebook running within the user interface of the JetBrains
    PyCharm IDE.
     {_JUPYTER_DESCRIPTION} {_PYCHARM_NOTE}.
    """

Literals class-attribute instance-attribute 

Literals = Literal['pycharm_jupyter']
Returned by: Used by:

PYCHARM_JUPYTER class-attribute instance-attribute 

PYCHARM_JUPYTER: Literal['pycharm_jupyter'] = 'pycharm_jupyter'

JupyterInBrowserUserInterfaceType

Bases: LiteralEnum[str]


              flowchart BT
              omnipy.shared.enums.ui.JupyterInBrowserUserInterfaceType[JupyterInBrowserUserInterfaceType]
              omnipy.util.literal_enum.LiteralEnum[LiteralEnum]

                              omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.JupyterInBrowserUserInterfaceType
                


              click omnipy.shared.enums.ui.JupyterInBrowserUserInterfaceType href "" "omnipy.shared.enums.ui.JupyterInBrowserUserInterfaceType"
              click omnipy.util.literal_enum.LiteralEnum href "" "omnipy.util.literal_enum.LiteralEnum"

Browser-hosted Jupyter UI enum values.

Returned by: Subclassed by: Used by:
ATTRIBUTE DESCRIPTION
JUPYTER

TYPE: Literal['jupyter']

Literals

Source code in src/omnipy/shared/enums/ui.py 
145
146
147
148
149
150
151
152
153
154
155
class JupyterInBrowserUserInterfaceType(LiteralEnum[str]):
    """Browser-hosted Jupyter UI enum values."""

    Literals = Literal['jupyter']

    JUPYTER: Literal['jupyter'] = 'jupyter'
    f"""Browser-hosted Jupyter notebook or JupyterLab UI.

    A Jupyter notebook or JupyterLab environment opened from a web browser.
     {_JUPYTER_DESCRIPTION}
    """

JUPYTER class-attribute instance-attribute 

JUPYTER: Literal['jupyter'] = 'jupyter'

Literals class-attribute instance-attribute 

Literals = Literal['jupyter']
Returned by: Used by:

JupyterUserInterfaceType

Bases: JupyterEmbeddedUserInterfaceType, JupyterInBrowserUserInterfaceType


              flowchart BT
              omnipy.shared.enums.ui.JupyterUserInterfaceType[JupyterUserInterfaceType]
              omnipy.shared.enums.ui.JupyterEmbeddedUserInterfaceType[JupyterEmbeddedUserInterfaceType]
              omnipy.shared.enums.ui.JupyterInBrowserUserInterfaceType[JupyterInBrowserUserInterfaceType]
              omnipy.util.literal_enum.LiteralEnum[LiteralEnum]

                              omnipy.shared.enums.ui.JupyterEmbeddedUserInterfaceType --> omnipy.shared.enums.ui.JupyterUserInterfaceType
                                omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.JupyterEmbeddedUserInterfaceType
                

                omnipy.shared.enums.ui.JupyterInBrowserUserInterfaceType --> omnipy.shared.enums.ui.JupyterUserInterfaceType
                                omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.JupyterInBrowserUserInterfaceType
                



              click omnipy.shared.enums.ui.JupyterUserInterfaceType href "" "omnipy.shared.enums.ui.JupyterUserInterfaceType"
              click omnipy.shared.enums.ui.JupyterEmbeddedUserInterfaceType href "" "omnipy.shared.enums.ui.JupyterEmbeddedUserInterfaceType"
              click omnipy.shared.enums.ui.JupyterInBrowserUserInterfaceType href "" "omnipy.shared.enums.ui.JupyterInBrowserUserInterfaceType"
              click omnipy.util.literal_enum.LiteralEnum href "" "omnipy.util.literal_enum.LiteralEnum"

Jupyter UI enum values for embedded and browser-hosted notebooks.

Returned by: Subclassed by: Used by:
ATTRIBUTE DESCRIPTION
Literals

Source code in src/omnipy/shared/enums/ui.py 
158
159
160
161
162
163
164
165
166
167
class JupyterUserInterfaceType(
        JupyterEmbeddedUserInterfaceType,
        JupyterInBrowserUserInterfaceType,
):
    """Jupyter UI enum values for embedded and browser-hosted notebooks."""

    Literals = Literal[
        JupyterEmbeddedUserInterfaceType.Literals,
        JupyterInBrowserUserInterfaceType.Literals,
    ]

Literals class-attribute instance-attribute 

Literals = Literal[
    JupyterEmbeddedUserInterfaceType.Literals, JupyterInBrowserUserInterfaceType.Literals
]
Returned by: Used by:

PlainTerminalEmbeddedUserInterfaceType

Bases: LiteralEnum[str]


              flowchart BT
              omnipy.shared.enums.ui.PlainTerminalEmbeddedUserInterfaceType[PlainTerminalEmbeddedUserInterfaceType]
              omnipy.util.literal_enum.LiteralEnum[LiteralEnum]

                              omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.PlainTerminalEmbeddedUserInterfaceType
                


              click omnipy.shared.enums.ui.PlainTerminalEmbeddedUserInterfaceType href "" "omnipy.shared.enums.ui.PlainTerminalEmbeddedUserInterfaceType"
              click omnipy.util.literal_enum.LiteralEnum href "" "omnipy.util.literal_enum.LiteralEnum"

Plain terminal UI enum values embedded inside another application.

Subclassed by: Used by:
ATTRIBUTE DESCRIPTION
Literals

PYCHARM_TERMINAL

TYPE: Literal['pycharm_terminal']

Source code in src/omnipy/shared/enums/ui.py 
46
47
48
49
50
51
52
53
54
55
56
class PlainTerminalEmbeddedUserInterfaceType(LiteralEnum[str]):
    """Plain terminal UI enum values embedded inside another application."""

    Literals = Literal['pycharm_terminal']

    PYCHARM_TERMINAL: Literal['pycharm_terminal'] = 'pycharm_terminal'
    f"""PyCharm terminal running the builtin Python REPL.

    The console and/or terminal of the JetBrains PyCharm IDE running with
    the Python interactive interpreter (REPL). {_PYCHARM_NOTE}
    """

Literals class-attribute instance-attribute 

Literals = Literal['pycharm_terminal']
Used by:

PYCHARM_TERMINAL class-attribute instance-attribute 

PYCHARM_TERMINAL: Literal['pycharm_terminal'] = 'pycharm_terminal'

PlainTerminalUserInterfaceType

Bases: PlainTerminalEmbeddedUserInterfaceType, LiteralEnum[str]


              flowchart BT
              omnipy.shared.enums.ui.PlainTerminalUserInterfaceType[PlainTerminalUserInterfaceType]
              omnipy.shared.enums.ui.PlainTerminalEmbeddedUserInterfaceType[PlainTerminalEmbeddedUserInterfaceType]
              omnipy.util.literal_enum.LiteralEnum[LiteralEnum]

                              omnipy.shared.enums.ui.PlainTerminalEmbeddedUserInterfaceType --> omnipy.shared.enums.ui.PlainTerminalUserInterfaceType
                                omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.PlainTerminalEmbeddedUserInterfaceType
                

                omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.PlainTerminalUserInterfaceType
                


              click omnipy.shared.enums.ui.PlainTerminalUserInterfaceType href "" "omnipy.shared.enums.ui.PlainTerminalUserInterfaceType"
              click omnipy.shared.enums.ui.PlainTerminalEmbeddedUserInterfaceType href "" "omnipy.shared.enums.ui.PlainTerminalEmbeddedUserInterfaceType"
              click omnipy.util.literal_enum.LiteralEnum href "" "omnipy.util.literal_enum.LiteralEnum"

Plain terminal UI enum values supported by Omnipy.

Returned by: Subclassed by: Used by:
ATTRIBUTE DESCRIPTION
Literals

TERMINAL

Standard Python REPL running in a terminal.

TYPE: Literal['terminal']

UNKNOWN

Fallback UI type when the environment cannot be determined.

TYPE: Literal['unknown']

Source code in src/omnipy/shared/enums/ui.py 
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
class PlainTerminalUserInterfaceType(PlainTerminalEmbeddedUserInterfaceType, LiteralEnum[str]):
    """Plain terminal UI enum values supported by Omnipy."""

    Literals = Literal['terminal', PlainTerminalEmbeddedUserInterfaceType.Literals, 'unknown']

    TERMINAL: Literal['terminal'] = 'terminal'
    """Standard Python REPL running in a terminal.

    A standard Python interactive interpreter (REPL), running within
    terminal-emulation software, such as the builtin "Terminal" app on Mac
    OS or GNOME Terminal on Linux, through a SSH connection to a remote
    server,  or directly on a console.
    """

    UNKNOWN: Literal['unknown'] = 'unknown'
    """Fallback UI type when the environment cannot be determined.

    The `UNKNOWN` user interface type is used when the user interface type
    cannot be determined. This will in practice produce the same output as
    for the `TERMINAL` display type. As is default for terminals, we try
    to autodetect color capabilities such as ANSI escape codes for color
    and text formatting (see `DisplayColorSystem.AUTO`).
    """

Literals class-attribute instance-attribute 

Literals = Literal['terminal', PlainTerminalEmbeddedUserInterfaceType.Literals, 'unknown']
Returned by: Used by:

TERMINAL class-attribute instance-attribute 

TERMINAL: Literal['terminal'] = 'terminal'

Standard Python REPL running in a terminal.

A standard Python interactive interpreter (REPL), running within terminal-emulation software, such as the builtin "Terminal" app on Mac OS or GNOME Terminal on Linux, through a SSH connection to a remote server, or directly on a console.

UNKNOWN class-attribute instance-attribute 

UNKNOWN: Literal['unknown'] = 'unknown'

Fallback UI type when the environment cannot be determined.

The UNKNOWN user interface type is used when the user interface type cannot be determined. This will in practice produce the same output as for the TERMINAL display type. As is default for terminals, we try to autodetect color capabilities such as ANSI escape codes for color and text formatting (see DisplayColorSystem.AUTO).

Used by:

RgbColorUserInterfaceType

Bases: PlainTerminalEmbeddedUserInterfaceType, IpythonEmbeddedTerminalUserInterfaceType, JupyterUserInterfaceType, BrowserUserInterfaceType


              flowchart BT
              omnipy.shared.enums.ui.RgbColorUserInterfaceType[RgbColorUserInterfaceType]
              omnipy.shared.enums.ui.PlainTerminalEmbeddedUserInterfaceType[PlainTerminalEmbeddedUserInterfaceType]
              omnipy.shared.enums.ui.IpythonEmbeddedTerminalUserInterfaceType[IpythonEmbeddedTerminalUserInterfaceType]
              omnipy.shared.enums.ui.JupyterUserInterfaceType[JupyterUserInterfaceType]
              omnipy.shared.enums.ui.JupyterEmbeddedUserInterfaceType[JupyterEmbeddedUserInterfaceType]
              omnipy.shared.enums.ui.JupyterInBrowserUserInterfaceType[JupyterInBrowserUserInterfaceType]
              omnipy.shared.enums.ui.BrowserUserInterfaceType[BrowserUserInterfaceType]
              omnipy.shared.enums.ui.BrowserPageUserInterfaceType[BrowserPageUserInterfaceType]
              omnipy.shared.enums.ui.BrowserTagUserInterfaceType[BrowserTagUserInterfaceType]
              omnipy.util.literal_enum.LiteralEnum[LiteralEnum]

                              omnipy.shared.enums.ui.PlainTerminalEmbeddedUserInterfaceType --> omnipy.shared.enums.ui.RgbColorUserInterfaceType
                                omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.PlainTerminalEmbeddedUserInterfaceType
                

                omnipy.shared.enums.ui.IpythonEmbeddedTerminalUserInterfaceType --> omnipy.shared.enums.ui.RgbColorUserInterfaceType
                                omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.IpythonEmbeddedTerminalUserInterfaceType
                

                omnipy.shared.enums.ui.JupyterUserInterfaceType --> omnipy.shared.enums.ui.RgbColorUserInterfaceType
                                omnipy.shared.enums.ui.JupyterEmbeddedUserInterfaceType --> omnipy.shared.enums.ui.JupyterUserInterfaceType
                                omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.JupyterEmbeddedUserInterfaceType
                

                omnipy.shared.enums.ui.JupyterInBrowserUserInterfaceType --> omnipy.shared.enums.ui.JupyterUserInterfaceType
                                omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.JupyterInBrowserUserInterfaceType
                


                omnipy.shared.enums.ui.BrowserUserInterfaceType --> omnipy.shared.enums.ui.RgbColorUserInterfaceType
                                omnipy.shared.enums.ui.BrowserPageUserInterfaceType --> omnipy.shared.enums.ui.BrowserUserInterfaceType
                                omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.BrowserPageUserInterfaceType
                

                omnipy.shared.enums.ui.BrowserTagUserInterfaceType --> omnipy.shared.enums.ui.BrowserUserInterfaceType
                                omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.BrowserTagUserInterfaceType
                




              click omnipy.shared.enums.ui.RgbColorUserInterfaceType href "" "omnipy.shared.enums.ui.RgbColorUserInterfaceType"
              click omnipy.shared.enums.ui.PlainTerminalEmbeddedUserInterfaceType href "" "omnipy.shared.enums.ui.PlainTerminalEmbeddedUserInterfaceType"
              click omnipy.shared.enums.ui.IpythonEmbeddedTerminalUserInterfaceType href "" "omnipy.shared.enums.ui.IpythonEmbeddedTerminalUserInterfaceType"
              click omnipy.shared.enums.ui.JupyterUserInterfaceType href "" "omnipy.shared.enums.ui.JupyterUserInterfaceType"
              click omnipy.shared.enums.ui.JupyterEmbeddedUserInterfaceType href "" "omnipy.shared.enums.ui.JupyterEmbeddedUserInterfaceType"
              click omnipy.shared.enums.ui.JupyterInBrowserUserInterfaceType href "" "omnipy.shared.enums.ui.JupyterInBrowserUserInterfaceType"
              click omnipy.shared.enums.ui.BrowserUserInterfaceType href "" "omnipy.shared.enums.ui.BrowserUserInterfaceType"
              click omnipy.shared.enums.ui.BrowserPageUserInterfaceType href "" "omnipy.shared.enums.ui.BrowserPageUserInterfaceType"
              click omnipy.shared.enums.ui.BrowserTagUserInterfaceType href "" "omnipy.shared.enums.ui.BrowserTagUserInterfaceType"
              click omnipy.util.literal_enum.LiteralEnum href "" "omnipy.util.literal_enum.LiteralEnum"

UI enum values that support RGB color output.

Returned by:
ATTRIBUTE DESCRIPTION
Literals

Source code in src/omnipy/shared/enums/ui.py 
203
204
205
206
207
208
209
210
211
212
213
214
class RgbColorUserInterfaceType(PlainTerminalEmbeddedUserInterfaceType,
                                IpythonEmbeddedTerminalUserInterfaceType,
                                JupyterUserInterfaceType,
                                BrowserUserInterfaceType):
    """UI enum values that support RGB color output."""

    Literals = Literal[
        PlainTerminalEmbeddedUserInterfaceType.Literals,
        IpythonEmbeddedTerminalUserInterfaceType.Literals,
        JupyterUserInterfaceType.Literals,
        BrowserUserInterfaceType.Literals,
    ]

Literals class-attribute instance-attribute 

Literals = Literal[
    PlainTerminalEmbeddedUserInterfaceType.Literals,
    IpythonEmbeddedTerminalUserInterfaceType.Literals,
    JupyterUserInterfaceType.Literals,
    BrowserUserInterfaceType.Literals,
]
Returned by:

SpecifiedUserInterfaceType

Bases: PlainTerminalUserInterfaceType, IpythonTerminalUserInterfaceType, JupyterUserInterfaceType, BrowserUserInterfaceType


              flowchart BT
              omnipy.shared.enums.ui.SpecifiedUserInterfaceType[SpecifiedUserInterfaceType]
              omnipy.shared.enums.ui.PlainTerminalUserInterfaceType[PlainTerminalUserInterfaceType]
              omnipy.shared.enums.ui.PlainTerminalEmbeddedUserInterfaceType[PlainTerminalEmbeddedUserInterfaceType]
              omnipy.shared.enums.ui.IpythonTerminalUserInterfaceType[IpythonTerminalUserInterfaceType]
              omnipy.shared.enums.ui.IpythonEmbeddedTerminalUserInterfaceType[IpythonEmbeddedTerminalUserInterfaceType]
              omnipy.shared.enums.ui.JupyterUserInterfaceType[JupyterUserInterfaceType]
              omnipy.shared.enums.ui.JupyterEmbeddedUserInterfaceType[JupyterEmbeddedUserInterfaceType]
              omnipy.shared.enums.ui.JupyterInBrowserUserInterfaceType[JupyterInBrowserUserInterfaceType]
              omnipy.shared.enums.ui.BrowserUserInterfaceType[BrowserUserInterfaceType]
              omnipy.shared.enums.ui.BrowserPageUserInterfaceType[BrowserPageUserInterfaceType]
              omnipy.shared.enums.ui.BrowserTagUserInterfaceType[BrowserTagUserInterfaceType]
              omnipy.util.literal_enum.LiteralEnum[LiteralEnum]

                              omnipy.shared.enums.ui.PlainTerminalUserInterfaceType --> omnipy.shared.enums.ui.SpecifiedUserInterfaceType
                                omnipy.shared.enums.ui.PlainTerminalEmbeddedUserInterfaceType --> omnipy.shared.enums.ui.PlainTerminalUserInterfaceType
                                omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.PlainTerminalEmbeddedUserInterfaceType
                

                omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.PlainTerminalUserInterfaceType
                

                omnipy.shared.enums.ui.IpythonTerminalUserInterfaceType --> omnipy.shared.enums.ui.SpecifiedUserInterfaceType
                                omnipy.shared.enums.ui.IpythonEmbeddedTerminalUserInterfaceType --> omnipy.shared.enums.ui.IpythonTerminalUserInterfaceType
                                omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.IpythonEmbeddedTerminalUserInterfaceType
                

                omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.IpythonTerminalUserInterfaceType
                

                omnipy.shared.enums.ui.JupyterUserInterfaceType --> omnipy.shared.enums.ui.SpecifiedUserInterfaceType
                                omnipy.shared.enums.ui.JupyterEmbeddedUserInterfaceType --> omnipy.shared.enums.ui.JupyterUserInterfaceType
                                omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.JupyterEmbeddedUserInterfaceType
                

                omnipy.shared.enums.ui.JupyterInBrowserUserInterfaceType --> omnipy.shared.enums.ui.JupyterUserInterfaceType
                                omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.JupyterInBrowserUserInterfaceType
                


                omnipy.shared.enums.ui.BrowserUserInterfaceType --> omnipy.shared.enums.ui.SpecifiedUserInterfaceType
                                omnipy.shared.enums.ui.BrowserPageUserInterfaceType --> omnipy.shared.enums.ui.BrowserUserInterfaceType
                                omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.BrowserPageUserInterfaceType
                

                omnipy.shared.enums.ui.BrowserTagUserInterfaceType --> omnipy.shared.enums.ui.BrowserUserInterfaceType
                                omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.BrowserTagUserInterfaceType
                




              click omnipy.shared.enums.ui.SpecifiedUserInterfaceType href "" "omnipy.shared.enums.ui.SpecifiedUserInterfaceType"
              click omnipy.shared.enums.ui.PlainTerminalUserInterfaceType href "" "omnipy.shared.enums.ui.PlainTerminalUserInterfaceType"
              click omnipy.shared.enums.ui.PlainTerminalEmbeddedUserInterfaceType href "" "omnipy.shared.enums.ui.PlainTerminalEmbeddedUserInterfaceType"
              click omnipy.shared.enums.ui.IpythonTerminalUserInterfaceType href "" "omnipy.shared.enums.ui.IpythonTerminalUserInterfaceType"
              click omnipy.shared.enums.ui.IpythonEmbeddedTerminalUserInterfaceType href "" "omnipy.shared.enums.ui.IpythonEmbeddedTerminalUserInterfaceType"
              click omnipy.shared.enums.ui.JupyterUserInterfaceType href "" "omnipy.shared.enums.ui.JupyterUserInterfaceType"
              click omnipy.shared.enums.ui.JupyterEmbeddedUserInterfaceType href "" "omnipy.shared.enums.ui.JupyterEmbeddedUserInterfaceType"
              click omnipy.shared.enums.ui.JupyterInBrowserUserInterfaceType href "" "omnipy.shared.enums.ui.JupyterInBrowserUserInterfaceType"
              click omnipy.shared.enums.ui.BrowserUserInterfaceType href "" "omnipy.shared.enums.ui.BrowserUserInterfaceType"
              click omnipy.shared.enums.ui.BrowserPageUserInterfaceType href "" "omnipy.shared.enums.ui.BrowserPageUserInterfaceType"
              click omnipy.shared.enums.ui.BrowserTagUserInterfaceType href "" "omnipy.shared.enums.ui.BrowserTagUserInterfaceType"
              click omnipy.util.literal_enum.LiteralEnum href "" "omnipy.util.literal_enum.LiteralEnum"

User interface types represented as explicit concrete UI values.

User interface types that are specified as a particular UI type, either automatically determined by Omnipy or hard-coded (i.e. for browser output). This is a union of all supported user interface types (including UNKNOWN), except for AUTO.

Returned by: Subclassed by: Used by:
ATTRIBUTE DESCRIPTION
Literals

Source code in src/omnipy/shared/enums/ui.py 
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
class SpecifiedUserInterfaceType(PlainTerminalUserInterfaceType,
                                 IpythonTerminalUserInterfaceType,
                                 JupyterUserInterfaceType,
                                 BrowserUserInterfaceType):
    """User interface types represented as explicit concrete UI values.

    User interface types that are specified as a particular UI type, either
    automatically determined by Omnipy or hard-coded (i.e. for browser
    output). This is a union of all supported user interface types
    (including `UNKNOWN`), except for `AUTO`.
    """

    Literals = Literal[
        PlainTerminalUserInterfaceType.Literals,
        IpythonTerminalUserInterfaceType.Literals,
        JupyterUserInterfaceType.Literals,
        BrowserUserInterfaceType.Literals,
    ]

Literals class-attribute instance-attribute 

Literals = Literal[
    PlainTerminalUserInterfaceType.Literals,
    IpythonTerminalUserInterfaceType.Literals,
    JupyterUserInterfaceType.Literals,
    BrowserUserInterfaceType.Literals,
]
Returned by: Used by:

SupportsDarkTerminalBgDetection

Bases: TerminalUserInterfaceType, JupyterEmbeddedUserInterfaceType


              flowchart BT
              omnipy.shared.enums.ui.SupportsDarkTerminalBgDetection[SupportsDarkTerminalBgDetection]
              omnipy.shared.enums.ui.TerminalUserInterfaceType[TerminalUserInterfaceType]
              omnipy.shared.enums.ui.PlainTerminalUserInterfaceType[PlainTerminalUserInterfaceType]
              omnipy.shared.enums.ui.PlainTerminalEmbeddedUserInterfaceType[PlainTerminalEmbeddedUserInterfaceType]
              omnipy.shared.enums.ui.IpythonTerminalUserInterfaceType[IpythonTerminalUserInterfaceType]
              omnipy.shared.enums.ui.IpythonEmbeddedTerminalUserInterfaceType[IpythonEmbeddedTerminalUserInterfaceType]
              omnipy.shared.enums.ui.JupyterEmbeddedUserInterfaceType[JupyterEmbeddedUserInterfaceType]
              omnipy.util.literal_enum.LiteralEnum[LiteralEnum]

                              omnipy.shared.enums.ui.TerminalUserInterfaceType --> omnipy.shared.enums.ui.SupportsDarkTerminalBgDetection
                                omnipy.shared.enums.ui.PlainTerminalUserInterfaceType --> omnipy.shared.enums.ui.TerminalUserInterfaceType
                                omnipy.shared.enums.ui.PlainTerminalEmbeddedUserInterfaceType --> omnipy.shared.enums.ui.PlainTerminalUserInterfaceType
                                omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.PlainTerminalEmbeddedUserInterfaceType
                

                omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.PlainTerminalUserInterfaceType
                

                omnipy.shared.enums.ui.IpythonTerminalUserInterfaceType --> omnipy.shared.enums.ui.TerminalUserInterfaceType
                                omnipy.shared.enums.ui.IpythonEmbeddedTerminalUserInterfaceType --> omnipy.shared.enums.ui.IpythonTerminalUserInterfaceType
                                omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.IpythonEmbeddedTerminalUserInterfaceType
                

                omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.IpythonTerminalUserInterfaceType
                


                omnipy.shared.enums.ui.JupyterEmbeddedUserInterfaceType --> omnipy.shared.enums.ui.SupportsDarkTerminalBgDetection
                                omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.JupyterEmbeddedUserInterfaceType
                



              click omnipy.shared.enums.ui.SupportsDarkTerminalBgDetection href "" "omnipy.shared.enums.ui.SupportsDarkTerminalBgDetection"
              click omnipy.shared.enums.ui.TerminalUserInterfaceType href "" "omnipy.shared.enums.ui.TerminalUserInterfaceType"
              click omnipy.shared.enums.ui.PlainTerminalUserInterfaceType href "" "omnipy.shared.enums.ui.PlainTerminalUserInterfaceType"
              click omnipy.shared.enums.ui.PlainTerminalEmbeddedUserInterfaceType href "" "omnipy.shared.enums.ui.PlainTerminalEmbeddedUserInterfaceType"
              click omnipy.shared.enums.ui.IpythonTerminalUserInterfaceType href "" "omnipy.shared.enums.ui.IpythonTerminalUserInterfaceType"
              click omnipy.shared.enums.ui.IpythonEmbeddedTerminalUserInterfaceType href "" "omnipy.shared.enums.ui.IpythonEmbeddedTerminalUserInterfaceType"
              click omnipy.shared.enums.ui.JupyterEmbeddedUserInterfaceType href "" "omnipy.shared.enums.ui.JupyterEmbeddedUserInterfaceType"
              click omnipy.util.literal_enum.LiteralEnum href "" "omnipy.util.literal_enum.LiteralEnum"

UI enum values that support dark terminal background detection.

Returned by:
ATTRIBUTE DESCRIPTION
Literals

Source code in src/omnipy/shared/enums/ui.py 
136
137
138
139
140
141
142
class SupportsDarkTerminalBgDetection(TerminalUserInterfaceType, JupyterEmbeddedUserInterfaceType):
    """UI enum values that support dark terminal background detection."""

    Literals = Literal[
        TerminalUserInterfaceType.Literals,
        JupyterEmbeddedUserInterfaceType.Literals,
    ]

Literals class-attribute instance-attribute 

Literals = Literal[TerminalUserInterfaceType.Literals, JupyterEmbeddedUserInterfaceType.Literals]
Returned by:

TerminalOutputUserInterfaceType

Bases: PlainTerminalUserInterfaceType, IpythonTerminalUserInterfaceType, JupyterEmbeddedUserInterfaceType


              flowchart BT
              omnipy.shared.enums.ui.TerminalOutputUserInterfaceType[TerminalOutputUserInterfaceType]
              omnipy.shared.enums.ui.PlainTerminalUserInterfaceType[PlainTerminalUserInterfaceType]
              omnipy.shared.enums.ui.PlainTerminalEmbeddedUserInterfaceType[PlainTerminalEmbeddedUserInterfaceType]
              omnipy.shared.enums.ui.IpythonTerminalUserInterfaceType[IpythonTerminalUserInterfaceType]
              omnipy.shared.enums.ui.IpythonEmbeddedTerminalUserInterfaceType[IpythonEmbeddedTerminalUserInterfaceType]
              omnipy.shared.enums.ui.JupyterEmbeddedUserInterfaceType[JupyterEmbeddedUserInterfaceType]
              omnipy.util.literal_enum.LiteralEnum[LiteralEnum]

                              omnipy.shared.enums.ui.PlainTerminalUserInterfaceType --> omnipy.shared.enums.ui.TerminalOutputUserInterfaceType
                                omnipy.shared.enums.ui.PlainTerminalEmbeddedUserInterfaceType --> omnipy.shared.enums.ui.PlainTerminalUserInterfaceType
                                omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.PlainTerminalEmbeddedUserInterfaceType
                

                omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.PlainTerminalUserInterfaceType
                

                omnipy.shared.enums.ui.IpythonTerminalUserInterfaceType --> omnipy.shared.enums.ui.TerminalOutputUserInterfaceType
                                omnipy.shared.enums.ui.IpythonEmbeddedTerminalUserInterfaceType --> omnipy.shared.enums.ui.IpythonTerminalUserInterfaceType
                                omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.IpythonEmbeddedTerminalUserInterfaceType
                

                omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.IpythonTerminalUserInterfaceType
                

                omnipy.shared.enums.ui.JupyterEmbeddedUserInterfaceType --> omnipy.shared.enums.ui.TerminalOutputUserInterfaceType
                                omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.JupyterEmbeddedUserInterfaceType
                



              click omnipy.shared.enums.ui.TerminalOutputUserInterfaceType href "" "omnipy.shared.enums.ui.TerminalOutputUserInterfaceType"
              click omnipy.shared.enums.ui.PlainTerminalUserInterfaceType href "" "omnipy.shared.enums.ui.PlainTerminalUserInterfaceType"
              click omnipy.shared.enums.ui.PlainTerminalEmbeddedUserInterfaceType href "" "omnipy.shared.enums.ui.PlainTerminalEmbeddedUserInterfaceType"
              click omnipy.shared.enums.ui.IpythonTerminalUserInterfaceType href "" "omnipy.shared.enums.ui.IpythonTerminalUserInterfaceType"
              click omnipy.shared.enums.ui.IpythonEmbeddedTerminalUserInterfaceType href "" "omnipy.shared.enums.ui.IpythonEmbeddedTerminalUserInterfaceType"
              click omnipy.shared.enums.ui.JupyterEmbeddedUserInterfaceType href "" "omnipy.shared.enums.ui.JupyterEmbeddedUserInterfaceType"
              click omnipy.util.literal_enum.LiteralEnum href "" "omnipy.util.literal_enum.LiteralEnum"

UI enum values that require ANSI terminal output.

Returned by: Used by:
ATTRIBUTE DESCRIPTION
Literals

Source code in src/omnipy/shared/enums/ui.py 
217
218
219
220
221
222
223
224
225
226
227
228
class TerminalOutputUserInterfaceType(
        PlainTerminalUserInterfaceType,
        IpythonTerminalUserInterfaceType,
        JupyterEmbeddedUserInterfaceType,
):
    """UI enum values that require ANSI terminal output."""

    Literals = Literal[
        PlainTerminalUserInterfaceType.Literals,
        IpythonTerminalUserInterfaceType.Literals,
        JupyterEmbeddedUserInterfaceType.Literals,
    ]

Literals class-attribute instance-attribute 

Literals = Literal[
    PlainTerminalUserInterfaceType.Literals,
    IpythonTerminalUserInterfaceType.Literals,
    JupyterEmbeddedUserInterfaceType.Literals,
]
Returned by: Used by:

TerminalUserInterfaceType

Bases: PlainTerminalUserInterfaceType, IpythonTerminalUserInterfaceType


              flowchart BT
              omnipy.shared.enums.ui.TerminalUserInterfaceType[TerminalUserInterfaceType]
              omnipy.shared.enums.ui.PlainTerminalUserInterfaceType[PlainTerminalUserInterfaceType]
              omnipy.shared.enums.ui.PlainTerminalEmbeddedUserInterfaceType[PlainTerminalEmbeddedUserInterfaceType]
              omnipy.shared.enums.ui.IpythonTerminalUserInterfaceType[IpythonTerminalUserInterfaceType]
              omnipy.shared.enums.ui.IpythonEmbeddedTerminalUserInterfaceType[IpythonEmbeddedTerminalUserInterfaceType]
              omnipy.util.literal_enum.LiteralEnum[LiteralEnum]

                              omnipy.shared.enums.ui.PlainTerminalUserInterfaceType --> omnipy.shared.enums.ui.TerminalUserInterfaceType
                                omnipy.shared.enums.ui.PlainTerminalEmbeddedUserInterfaceType --> omnipy.shared.enums.ui.PlainTerminalUserInterfaceType
                                omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.PlainTerminalEmbeddedUserInterfaceType
                

                omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.PlainTerminalUserInterfaceType
                

                omnipy.shared.enums.ui.IpythonTerminalUserInterfaceType --> omnipy.shared.enums.ui.TerminalUserInterfaceType
                                omnipy.shared.enums.ui.IpythonEmbeddedTerminalUserInterfaceType --> omnipy.shared.enums.ui.IpythonTerminalUserInterfaceType
                                omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.IpythonEmbeddedTerminalUserInterfaceType
                

                omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.IpythonTerminalUserInterfaceType
                



              click omnipy.shared.enums.ui.TerminalUserInterfaceType href "" "omnipy.shared.enums.ui.TerminalUserInterfaceType"
              click omnipy.shared.enums.ui.PlainTerminalUserInterfaceType href "" "omnipy.shared.enums.ui.PlainTerminalUserInterfaceType"
              click omnipy.shared.enums.ui.PlainTerminalEmbeddedUserInterfaceType href "" "omnipy.shared.enums.ui.PlainTerminalEmbeddedUserInterfaceType"
              click omnipy.shared.enums.ui.IpythonTerminalUserInterfaceType href "" "omnipy.shared.enums.ui.IpythonTerminalUserInterfaceType"
              click omnipy.shared.enums.ui.IpythonEmbeddedTerminalUserInterfaceType href "" "omnipy.shared.enums.ui.IpythonEmbeddedTerminalUserInterfaceType"
              click omnipy.util.literal_enum.LiteralEnum href "" "omnipy.util.literal_enum.LiteralEnum"

Terminal UI enum values covering plain and IPython terminals.

Returned by: Subclassed by: Used by:
ATTRIBUTE DESCRIPTION
Literals

Source code in src/omnipy/shared/enums/ui.py 
113
114
115
116
117
118
119
class TerminalUserInterfaceType(PlainTerminalUserInterfaceType, IpythonTerminalUserInterfaceType):
    """Terminal UI enum values covering plain and IPython terminals."""

    Literals = Literal[
        PlainTerminalUserInterfaceType.Literals,
        IpythonTerminalUserInterfaceType.Literals,
    ]

Literals class-attribute instance-attribute 

Literals = Literal[
    PlainTerminalUserInterfaceType.Literals, IpythonTerminalUserInterfaceType.Literals
]
Returned by: Used by:

UserInterfaceType

Bases: SpecifiedUserInterfaceType, LiteralEnum[str]


              flowchart BT
              omnipy.shared.enums.ui.UserInterfaceType[UserInterfaceType]
              omnipy.shared.enums.ui.SpecifiedUserInterfaceType[SpecifiedUserInterfaceType]
              omnipy.shared.enums.ui.PlainTerminalUserInterfaceType[PlainTerminalUserInterfaceType]
              omnipy.shared.enums.ui.PlainTerminalEmbeddedUserInterfaceType[PlainTerminalEmbeddedUserInterfaceType]
              omnipy.shared.enums.ui.IpythonTerminalUserInterfaceType[IpythonTerminalUserInterfaceType]
              omnipy.shared.enums.ui.IpythonEmbeddedTerminalUserInterfaceType[IpythonEmbeddedTerminalUserInterfaceType]
              omnipy.shared.enums.ui.JupyterUserInterfaceType[JupyterUserInterfaceType]
              omnipy.shared.enums.ui.JupyterEmbeddedUserInterfaceType[JupyterEmbeddedUserInterfaceType]
              omnipy.shared.enums.ui.JupyterInBrowserUserInterfaceType[JupyterInBrowserUserInterfaceType]
              omnipy.shared.enums.ui.BrowserUserInterfaceType[BrowserUserInterfaceType]
              omnipy.shared.enums.ui.BrowserPageUserInterfaceType[BrowserPageUserInterfaceType]
              omnipy.shared.enums.ui.BrowserTagUserInterfaceType[BrowserTagUserInterfaceType]
              omnipy.util.literal_enum.LiteralEnum[LiteralEnum]

                              omnipy.shared.enums.ui.SpecifiedUserInterfaceType --> omnipy.shared.enums.ui.UserInterfaceType
                                omnipy.shared.enums.ui.PlainTerminalUserInterfaceType --> omnipy.shared.enums.ui.SpecifiedUserInterfaceType
                                omnipy.shared.enums.ui.PlainTerminalEmbeddedUserInterfaceType --> omnipy.shared.enums.ui.PlainTerminalUserInterfaceType
                                omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.PlainTerminalEmbeddedUserInterfaceType
                

                omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.PlainTerminalUserInterfaceType
                

                omnipy.shared.enums.ui.IpythonTerminalUserInterfaceType --> omnipy.shared.enums.ui.SpecifiedUserInterfaceType
                                omnipy.shared.enums.ui.IpythonEmbeddedTerminalUserInterfaceType --> omnipy.shared.enums.ui.IpythonTerminalUserInterfaceType
                                omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.IpythonEmbeddedTerminalUserInterfaceType
                

                omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.IpythonTerminalUserInterfaceType
                

                omnipy.shared.enums.ui.JupyterUserInterfaceType --> omnipy.shared.enums.ui.SpecifiedUserInterfaceType
                                omnipy.shared.enums.ui.JupyterEmbeddedUserInterfaceType --> omnipy.shared.enums.ui.JupyterUserInterfaceType
                                omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.JupyterEmbeddedUserInterfaceType
                

                omnipy.shared.enums.ui.JupyterInBrowserUserInterfaceType --> omnipy.shared.enums.ui.JupyterUserInterfaceType
                                omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.JupyterInBrowserUserInterfaceType
                


                omnipy.shared.enums.ui.BrowserUserInterfaceType --> omnipy.shared.enums.ui.SpecifiedUserInterfaceType
                                omnipy.shared.enums.ui.BrowserPageUserInterfaceType --> omnipy.shared.enums.ui.BrowserUserInterfaceType
                                omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.BrowserPageUserInterfaceType
                

                omnipy.shared.enums.ui.BrowserTagUserInterfaceType --> omnipy.shared.enums.ui.BrowserUserInterfaceType
                                omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.BrowserTagUserInterfaceType
                



                omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.ui.UserInterfaceType
                


              click omnipy.shared.enums.ui.UserInterfaceType href "" "omnipy.shared.enums.ui.UserInterfaceType"
              click omnipy.shared.enums.ui.SpecifiedUserInterfaceType href "" "omnipy.shared.enums.ui.SpecifiedUserInterfaceType"
              click omnipy.shared.enums.ui.PlainTerminalUserInterfaceType href "" "omnipy.shared.enums.ui.PlainTerminalUserInterfaceType"
              click omnipy.shared.enums.ui.PlainTerminalEmbeddedUserInterfaceType href "" "omnipy.shared.enums.ui.PlainTerminalEmbeddedUserInterfaceType"
              click omnipy.shared.enums.ui.IpythonTerminalUserInterfaceType href "" "omnipy.shared.enums.ui.IpythonTerminalUserInterfaceType"
              click omnipy.shared.enums.ui.IpythonEmbeddedTerminalUserInterfaceType href "" "omnipy.shared.enums.ui.IpythonEmbeddedTerminalUserInterfaceType"
              click omnipy.shared.enums.ui.JupyterUserInterfaceType href "" "omnipy.shared.enums.ui.JupyterUserInterfaceType"
              click omnipy.shared.enums.ui.JupyterEmbeddedUserInterfaceType href "" "omnipy.shared.enums.ui.JupyterEmbeddedUserInterfaceType"
              click omnipy.shared.enums.ui.JupyterInBrowserUserInterfaceType href "" "omnipy.shared.enums.ui.JupyterInBrowserUserInterfaceType"
              click omnipy.shared.enums.ui.BrowserUserInterfaceType href "" "omnipy.shared.enums.ui.BrowserUserInterfaceType"
              click omnipy.shared.enums.ui.BrowserPageUserInterfaceType href "" "omnipy.shared.enums.ui.BrowserPageUserInterfaceType"
              click omnipy.shared.enums.ui.BrowserTagUserInterfaceType href "" "omnipy.shared.enums.ui.BrowserTagUserInterfaceType"
              click omnipy.util.literal_enum.LiteralEnum href "" "omnipy.util.literal_enum.LiteralEnum"

Describe the interface type used for Omnipy interaction and output.

Describes the type of interface in use for interacting with the user, encompassing the support available for displaying output as well as how the user interacts with the library (including the type of interactive interpreter used, if any).

Should be automatically determined by Omnipy, but the user can also be set the user interface type manually in the config if for some reason needed (e.g. if auto-detection fails). In particular, the user can expect this to fail in other IDEs than PyCharm, which is the only IDE currently supported by Omnipy.

Used by:
METHOD DESCRIPTION
is_browser

Check whether a UI type is a browser output variant.
is_ipython_terminal

Check whether a UI type is an IPython terminal variant.
is_jupyter

Check whether a UI type is any Jupyter variant.
is_jupyter_embedded

Check whether a UI type is an embedded Jupyter variant.
is_jupyter_in_browser

Check whether a UI type is a browser-hosted Jupyter variant.
is_plain_terminal

Check whether a UI type is a plain terminal variant.
is_terminal

Check whether a UI type is any terminal variant.
requires_html_page_output

Check whether a UI type requires full HTML page output.
requires_html_tag_output

Check whether a UI type requires self-contained HTML tag output.
requires_terminal_output

Check whether a UI type requires ANSI terminal-style output.
supports_dark_terminal_bg_detection

Check whether a UI type supports dark terminal background detection.
supports_rgb_color_output

Check whether a UI type supports RGB color output.
ATTRIBUTE DESCRIPTION
AUTO

Automatically detect the user interface type.

TYPE: Literal['auto']

Literals

Source code in src/omnipy/shared/enums/ui.py 
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
class UserInterfaceType(SpecifiedUserInterfaceType, LiteralEnum[str]):
    """Describe the interface type used for Omnipy interaction and output.

    Describes the type of interface in use for interacting with the user,
    encompassing the support available for displaying output as well as how
    the user interacts with the library (including the type of interactive
    interpreter used, if any).

    Should be automatically determined by Omnipy, but the user can also be
    set the user interface type manually in the config if for some reason
    needed (e.g. if auto-detection fails). In particular, the user can
    expect this to fail in other IDEs than PyCharm, which is the only IDE
    currently supported by Omnipy.
    """

    Literals = Literal[SpecifiedUserInterfaceType.Literals, 'auto']

    AUTO: Literal['auto'] = 'auto'
    """Automatically detect the user interface type.

    The `AUTO` user interface type is used to describe that the user
    interface type has not yet been determined, and that it should be
    automatically determined by Omnipy. This is the default value.
    """
    @classmethod
    def is_plain_terminal(
            cls, ui_type: 'UserInterfaceType.Literals'
    ) -> TypeIs[PlainTerminalUserInterfaceType.Literals]:
        """Check whether a UI type is a plain terminal variant.

        Args:
            ui_type: User interface type literal to classify.

        Returns:
            True if ``ui_type`` is a non-IPython terminal type. ``UNKNOWN``
            is treated as a terminal type.
        """
        return ui_type in PlainTerminalUserInterfaceType

    @classmethod
    def is_ipython_terminal(
            cls, ui_type: 'UserInterfaceType.Literals'
    ) -> TypeIs[IpythonTerminalUserInterfaceType.Literals]:
        """Check whether a UI type is an IPython terminal variant.

        Args:
            ui_type: User interface type literal to classify.

        Returns:
            True if ``ui_type`` refers to an IPython terminal UI type.
        """
        return ui_type in IpythonTerminalUserInterfaceType

    @classmethod
    def is_terminal(
            cls,
            ui_type: 'UserInterfaceType.Literals') -> TypeIs[TerminalUserInterfaceType.Literals]:
        """Check whether a UI type is any terminal variant.

        Args:
            ui_type: User interface type literal to classify.

        Returns:
            True if ``ui_type`` is a plain-terminal or IPython-terminal type.
            ``UNKNOWN`` is treated as a terminal type.
        """
        return ui_type in TerminalUserInterfaceType

    @classmethod
    def is_jupyter_embedded(
            cls, ui_type: 'UserInterfaceType.Literals'
    ) -> TypeIs[JupyterEmbeddedUserInterfaceType.Literals]:
        """Check whether a UI type is an embedded Jupyter variant.

        Args:
            ui_type: User interface type literal to classify.

        Returns:
            True if ``ui_type`` refers to Jupyter embedded in another app.
        """
        return ui_type in JupyterEmbeddedUserInterfaceType

    @classmethod
    def supports_dark_terminal_bg_detection(
            cls, ui_type: 'UserInterfaceType.Literals'
    ) -> TypeIs[SupportsDarkTerminalBgDetection.Literals]:
        """Check whether a UI type supports dark terminal background detection.

        Args:
            ui_type: User interface type literal to classify.

        Returns:
            True if ``ui_type`` supports terminal-style dark background
            detection.
        """
        return ui_type in SupportsDarkTerminalBgDetection

    @classmethod
    def is_jupyter_in_browser(
        cls, ui_type: 'UserInterfaceType.Literals'
    ) -> TypeIs[JupyterInBrowserUserInterfaceType.Literals]:
        """Check whether a UI type is a browser-hosted Jupyter variant.

        Args:
            ui_type: User interface type literal to classify.

        Returns:
            True if ``ui_type`` refers to Jupyter or JupyterLab in a browser.
        """
        return ui_type in JupyterInBrowserUserInterfaceType

    @classmethod
    def is_jupyter(
            cls,
            ui_type: 'UserInterfaceType.Literals') -> TypeIs[JupyterUserInterfaceType.Literals]:
        """Check whether a UI type is any Jupyter variant.

        Args:
            ui_type: User interface type literal to classify.

        Returns:
            True if ``ui_type`` refers to Jupyter in embedded or browser form.
        """
        return ui_type in JupyterUserInterfaceType

    @classmethod
    def is_browser(
            cls,
            ui_type: 'UserInterfaceType.Literals') -> TypeIs[BrowserUserInterfaceType.Literals]:
        """Check whether a UI type is a browser output variant.

        Args:
            ui_type: User interface type literal to classify.

        Returns:
            True if ``ui_type`` maps to one of the browser output types.
        """
        return ui_type in BrowserUserInterfaceType

    @classmethod
    def supports_rgb_color_output(
            cls,
            ui_type: 'UserInterfaceType.Literals') -> TypeIs[RgbColorUserInterfaceType.Literals]:
        """Check whether a UI type supports RGB color output.

        Args:
            ui_type: User interface type literal to classify.

        Returns:
            True if ``ui_type`` supports RGB color rendering.
        """
        return ui_type in RgbColorUserInterfaceType

    @classmethod
    def requires_terminal_output(
            cls, ui_type: 'UserInterfaceType.Literals'
    ) -> TypeIs[TerminalOutputUserInterfaceType.Literals]:
        """Check whether a UI type requires ANSI terminal-style output.

        Args:
            ui_type: User interface type literal to classify.

        Returns:
            True if ``ui_type`` requires terminal-encoded output. ``UNKNOWN``
            is treated as terminal output.
        """
        return ui_type in TerminalOutputUserInterfaceType

    @classmethod
    def requires_html_tag_output(
            cls, ui_type: 'UserInterfaceType.Literals'
    ) -> TypeIs[HtmlTagOutputUserInterfaceType.Literals]:
        """Check whether a UI type requires self-contained HTML tag output.

        Args:
            ui_type: User interface type literal to classify.

        Returns:
            True if ``ui_type`` requires embeddable HTML tag output.
        """
        return ui_type in HtmlTagOutputUserInterfaceType

    @classmethod
    def requires_html_page_output(
            cls, ui_type: 'UserInterfaceType.Literals'
    ) -> TypeIs[HtmlPageOutputUserInterfaceType.Literals]:
        """Check whether a UI type requires full HTML page output.

        Args:
            ui_type: User interface type literal to classify.

        Returns:
            True if ``ui_type`` requires full-page HTML output.
        """
        return ui_type in HtmlPageOutputUserInterfaceType

AUTO class-attribute instance-attribute 

AUTO: Literal['auto'] = 'auto'

Automatically detect the user interface type.

The AUTO user interface type is used to describe that the user interface type has not yet been determined, and that it should be automatically determined by Omnipy. This is the default value.

Literals class-attribute instance-attribute 

Literals = Literal[SpecifiedUserInterfaceType.Literals, 'auto']
Used by:

is_browser classmethod 

is_browser(ui_type: UserInterfaceType.Literals) -> TypeIs[BrowserUserInterfaceType.Literals]

Check whether a UI type is a browser output variant.

PARAMETER DESCRIPTION
ui_type

User interface type literal to classify.

TYPE: UserInterfaceType.Literals

RETURNS DESCRIPTION
TypeIs[BrowserUserInterfaceType.Literals]

True if ui_type maps to one of the browser output types.
Source code in src/omnipy/shared/enums/ui.py 
412
413
414
415
416
417
418
419
420
421
422
423
424
@classmethod
def is_browser(
        cls,
        ui_type: 'UserInterfaceType.Literals') -> TypeIs[BrowserUserInterfaceType.Literals]:
    """Check whether a UI type is a browser output variant.

    Args:
        ui_type: User interface type literal to classify.

    Returns:
        True if ``ui_type`` maps to one of the browser output types.
    """
    return ui_type in BrowserUserInterfaceType

is_ipython_terminal classmethod 

is_ipython_terminal(
    ui_type: UserInterfaceType.Literals,
) -> TypeIs[IpythonTerminalUserInterfaceType.Literals]

Check whether a UI type is an IPython terminal variant.

PARAMETER DESCRIPTION
ui_type

User interface type literal to classify.

TYPE: UserInterfaceType.Literals

RETURNS DESCRIPTION
TypeIs[IpythonTerminalUserInterfaceType.Literals]

True if ui_type refers to an IPython terminal UI type.
Source code in src/omnipy/shared/enums/ui.py 
326
327
328
329
330
331
332
333
334
335
336
337
338
@classmethod
def is_ipython_terminal(
        cls, ui_type: 'UserInterfaceType.Literals'
) -> TypeIs[IpythonTerminalUserInterfaceType.Literals]:
    """Check whether a UI type is an IPython terminal variant.

    Args:
        ui_type: User interface type literal to classify.

    Returns:
        True if ``ui_type`` refers to an IPython terminal UI type.
    """
    return ui_type in IpythonTerminalUserInterfaceType

is_jupyter classmethod 

is_jupyter(ui_type: UserInterfaceType.Literals) -> TypeIs[JupyterUserInterfaceType.Literals]

Check whether a UI type is any Jupyter variant.

PARAMETER DESCRIPTION
ui_type

User interface type literal to classify.

TYPE: UserInterfaceType.Literals

RETURNS DESCRIPTION
TypeIs[JupyterUserInterfaceType.Literals]

True if ui_type refers to Jupyter in embedded or browser form.
Source code in src/omnipy/shared/enums/ui.py 
398
399
400
401
402
403
404
405
406
407
408
409
410
@classmethod
def is_jupyter(
        cls,
        ui_type: 'UserInterfaceType.Literals') -> TypeIs[JupyterUserInterfaceType.Literals]:
    """Check whether a UI type is any Jupyter variant.

    Args:
        ui_type: User interface type literal to classify.

    Returns:
        True if ``ui_type`` refers to Jupyter in embedded or browser form.
    """
    return ui_type in JupyterUserInterfaceType

is_jupyter_embedded classmethod 

is_jupyter_embedded(
    ui_type: UserInterfaceType.Literals,
) -> TypeIs[JupyterEmbeddedUserInterfaceType.Literals]

Check whether a UI type is an embedded Jupyter variant.

PARAMETER DESCRIPTION
ui_type

User interface type literal to classify.

TYPE: UserInterfaceType.Literals

RETURNS DESCRIPTION
TypeIs[JupyterEmbeddedUserInterfaceType.Literals]

True if ui_type refers to Jupyter embedded in another app.
Source code in src/omnipy/shared/enums/ui.py 
355
356
357
358
359
360
361
362
363
364
365
366
367
@classmethod
def is_jupyter_embedded(
        cls, ui_type: 'UserInterfaceType.Literals'
) -> TypeIs[JupyterEmbeddedUserInterfaceType.Literals]:
    """Check whether a UI type is an embedded Jupyter variant.

    Args:
        ui_type: User interface type literal to classify.

    Returns:
        True if ``ui_type`` refers to Jupyter embedded in another app.
    """
    return ui_type in JupyterEmbeddedUserInterfaceType

is_jupyter_in_browser classmethod 

is_jupyter_in_browser(
    ui_type: UserInterfaceType.Literals,
) -> TypeIs[JupyterInBrowserUserInterfaceType.Literals]

Check whether a UI type is a browser-hosted Jupyter variant.

PARAMETER DESCRIPTION
ui_type

User interface type literal to classify.

TYPE: UserInterfaceType.Literals

RETURNS DESCRIPTION
TypeIs[JupyterInBrowserUserInterfaceType.Literals]

True if ui_type refers to Jupyter or JupyterLab in a browser.
Source code in src/omnipy/shared/enums/ui.py 
384
385
386
387
388
389
390
391
392
393
394
395
396
@classmethod
def is_jupyter_in_browser(
    cls, ui_type: 'UserInterfaceType.Literals'
) -> TypeIs[JupyterInBrowserUserInterfaceType.Literals]:
    """Check whether a UI type is a browser-hosted Jupyter variant.

    Args:
        ui_type: User interface type literal to classify.

    Returns:
        True if ``ui_type`` refers to Jupyter or JupyterLab in a browser.
    """
    return ui_type in JupyterInBrowserUserInterfaceType

is_plain_terminal classmethod 

is_plain_terminal(
    ui_type: UserInterfaceType.Literals,
) -> TypeIs[PlainTerminalUserInterfaceType.Literals]

Check whether a UI type is a plain terminal variant.

PARAMETER DESCRIPTION
ui_type

User interface type literal to classify.

TYPE: UserInterfaceType.Literals

RETURNS DESCRIPTION
TypeIs[PlainTerminalUserInterfaceType.Literals]

True if ui_type is a non-IPython terminal type. UNKNOWN is treated as a terminal type.
Source code in src/omnipy/shared/enums/ui.py 
311
312
313
314
315
316
317
318
319
320
321
322
323
324
@classmethod
def is_plain_terminal(
        cls, ui_type: 'UserInterfaceType.Literals'
) -> TypeIs[PlainTerminalUserInterfaceType.Literals]:
    """Check whether a UI type is a plain terminal variant.

    Args:
        ui_type: User interface type literal to classify.

    Returns:
        True if ``ui_type`` is a non-IPython terminal type. ``UNKNOWN``
        is treated as a terminal type.
    """
    return ui_type in PlainTerminalUserInterfaceType

is_terminal classmethod 

is_terminal(ui_type: UserInterfaceType.Literals) -> TypeIs[TerminalUserInterfaceType.Literals]

Check whether a UI type is any terminal variant.

PARAMETER DESCRIPTION
ui_type

User interface type literal to classify.

TYPE: UserInterfaceType.Literals

RETURNS DESCRIPTION
TypeIs[TerminalUserInterfaceType.Literals]

True if ui_type is a plain-terminal or IPython-terminal type. UNKNOWN is treated as a terminal type.
Source code in src/omnipy/shared/enums/ui.py 
340
341
342
343
344
345
346
347
348
349
350
351
352
353
@classmethod
def is_terminal(
        cls,
        ui_type: 'UserInterfaceType.Literals') -> TypeIs[TerminalUserInterfaceType.Literals]:
    """Check whether a UI type is any terminal variant.

    Args:
        ui_type: User interface type literal to classify.

    Returns:
        True if ``ui_type`` is a plain-terminal or IPython-terminal type.
        ``UNKNOWN`` is treated as a terminal type.
    """
    return ui_type in TerminalUserInterfaceType

requires_html_page_output classmethod 

requires_html_page_output(
    ui_type: UserInterfaceType.Literals,
) -> TypeIs[HtmlPageOutputUserInterfaceType.Literals]

Check whether a UI type requires full HTML page output.

PARAMETER DESCRIPTION
ui_type

User interface type literal to classify.

TYPE: UserInterfaceType.Literals

RETURNS DESCRIPTION
TypeIs[HtmlPageOutputUserInterfaceType.Literals]

True if ui_type requires full-page HTML output.
Source code in src/omnipy/shared/enums/ui.py 
469
470
471
472
473
474
475
476
477
478
479
480
481
@classmethod
def requires_html_page_output(
        cls, ui_type: 'UserInterfaceType.Literals'
) -> TypeIs[HtmlPageOutputUserInterfaceType.Literals]:
    """Check whether a UI type requires full HTML page output.

    Args:
        ui_type: User interface type literal to classify.

    Returns:
        True if ``ui_type`` requires full-page HTML output.
    """
    return ui_type in HtmlPageOutputUserInterfaceType

requires_html_tag_output classmethod 

requires_html_tag_output(
    ui_type: UserInterfaceType.Literals,
) -> TypeIs[HtmlTagOutputUserInterfaceType.Literals]

Check whether a UI type requires self-contained HTML tag output.

PARAMETER DESCRIPTION
ui_type

User interface type literal to classify.

TYPE: UserInterfaceType.Literals

RETURNS DESCRIPTION
TypeIs[HtmlTagOutputUserInterfaceType.Literals]

True if ui_type requires embeddable HTML tag output.
Source code in src/omnipy/shared/enums/ui.py 
455
456
457
458
459
460
461
462
463
464
465
466
467
@classmethod
def requires_html_tag_output(
        cls, ui_type: 'UserInterfaceType.Literals'
) -> TypeIs[HtmlTagOutputUserInterfaceType.Literals]:
    """Check whether a UI type requires self-contained HTML tag output.

    Args:
        ui_type: User interface type literal to classify.

    Returns:
        True if ``ui_type`` requires embeddable HTML tag output.
    """
    return ui_type in HtmlTagOutputUserInterfaceType

requires_terminal_output classmethod 

requires_terminal_output(
    ui_type: UserInterfaceType.Literals,
) -> TypeIs[TerminalOutputUserInterfaceType.Literals]

Check whether a UI type requires ANSI terminal-style output.

PARAMETER DESCRIPTION
ui_type

User interface type literal to classify.

TYPE: UserInterfaceType.Literals

RETURNS DESCRIPTION
TypeIs[TerminalOutputUserInterfaceType.Literals]

True if ui_type requires terminal-encoded output. UNKNOWN is treated as terminal output.
Source code in src/omnipy/shared/enums/ui.py 
440
441
442
443
444
445
446
447
448
449
450
451
452
453
@classmethod
def requires_terminal_output(
        cls, ui_type: 'UserInterfaceType.Literals'
) -> TypeIs[TerminalOutputUserInterfaceType.Literals]:
    """Check whether a UI type requires ANSI terminal-style output.

    Args:
        ui_type: User interface type literal to classify.

    Returns:
        True if ``ui_type`` requires terminal-encoded output. ``UNKNOWN``
        is treated as terminal output.
    """
    return ui_type in TerminalOutputUserInterfaceType

supports_dark_terminal_bg_detection classmethod 

supports_dark_terminal_bg_detection(
    ui_type: UserInterfaceType.Literals,
) -> TypeIs[SupportsDarkTerminalBgDetection.Literals]

Check whether a UI type supports dark terminal background detection.

PARAMETER DESCRIPTION
ui_type

User interface type literal to classify.

TYPE: UserInterfaceType.Literals

RETURNS DESCRIPTION
TypeIs[SupportsDarkTerminalBgDetection.Literals]

True if ui_type supports terminal-style dark background detection.
Source code in src/omnipy/shared/enums/ui.py 
369
370
371
372
373
374
375
376
377
378
379
380
381
382
@classmethod
def supports_dark_terminal_bg_detection(
        cls, ui_type: 'UserInterfaceType.Literals'
) -> TypeIs[SupportsDarkTerminalBgDetection.Literals]:
    """Check whether a UI type supports dark terminal background detection.

    Args:
        ui_type: User interface type literal to classify.

    Returns:
        True if ``ui_type`` supports terminal-style dark background
        detection.
    """
    return ui_type in SupportsDarkTerminalBgDetection

supports_rgb_color_output classmethod 

supports_rgb_color_output(
    ui_type: UserInterfaceType.Literals,
) -> TypeIs[RgbColorUserInterfaceType.Literals]

Check whether a UI type supports RGB color output.

PARAMETER DESCRIPTION
ui_type

User interface type literal to classify.

TYPE: UserInterfaceType.Literals

RETURNS DESCRIPTION
TypeIs[RgbColorUserInterfaceType.Literals]

True if ui_type supports RGB color rendering.
Source code in src/omnipy/shared/enums/ui.py 
426
427
428
429
430
431
432
433
434
435
436
437
438
@classmethod
def supports_rgb_color_output(
        cls,
        ui_type: 'UserInterfaceType.Literals') -> TypeIs[RgbColorUserInterfaceType.Literals]:
    """Check whether a UI type supports RGB color output.

    Args:
        ui_type: User interface type literal to classify.

    Returns:
        True if ``ui_type`` supports RGB color rendering.
    """
    return ui_type in RgbColorUserInterfaceType