Examples

Live demos

Functions

gp_demo_api.demo_function(name, count=1)

function

function

gp_demo_api.demo_function(name, count=1)

Plain function. Shows function type badge.

Parameters:

• name (str) – The name to repeat.

• count (int) – Number of repetitions.

Returns:

A list of repeated names.

Return type:

list[str]

async gp_demo_api.demo_async_function(url)

async function

async function

async gp_demo_api.demo_async_function(url)

Asynchronous function. Shows async + function badges.

Parameters:

url (str) – The URL to fetch.

Returns:

The fetched content.

Return type:

bytes

gp_demo_api.demo_deprecated_function()

deprecated function

deprecated function

gp_demo_api.demo_deprecated_function()

Do nothing (deprecated placeholder).

Shows deprecated + function badges.

Deprecated since version 2.0: Use demo_function() instead.

Return type:

None

Module data

gp_demo_api.DEMO_CONSTANT: int = 42

data

data

gp_demo_api.DEMO_CONSTANT: int = 42

Module-level constant. Shows data type badge.

Exceptions

exception gp_demo_api.DemoError

exception

exception

exception gp_demo_api.DemoError

Bases: Exception

Custom exception class. Shows exception type badge.

Raised when a demo operation fails unexpectedly.

Classes

class gp_demo_api.DemoClass

class

class

class gp_demo_api.DemoClass

Bases: object

Demonstration class with various method types.

Shows class type badge on the class itself, and per-method badges for each method kind.

Parameters:

value (str) – Initial value for the demo instance.

demo_attr: str = 'hello'

attribute

attribute

demo_attr: str = 'hello'

Class attribute. Shows attribute type badge.

__init__(value)

method

method

__init__(value)

Parameters:

value (str)

Return type:

None

regular_method(x)

method

method

regular_method(x)

Regular instance method. Shows method type badge.

Parameters:

x (int) – Input value.

Returns:

String representation.

Return type:

str

classmethod from_int(n)

classmethod method

classmethod method

classmethod from_int(n)

Class method. Shows classmethod + method badges.

Parameters:

n (int) – Integer to convert.

Returns:

A new instance.

Return type:

DemoClass

static utility(a, b)

staticmethod method

staticmethod method

static utility(a, b)

Add two integers. Shows staticmethod + method badges.

Parameters:

• a (int) – First operand.

• b (int) – Second operand.

Returns:

Sum of operands.

Return type:

int

property computed: str

property

property

property computed: str

Computed property. Shows property type badge.

Returns:

The uppercased value.

Return type:

str

async async_method()

async method

async method

async async_method()

Asynchronous method. Shows async + method badges.

Return type:

None

deprecated_method()

deprecated method

deprecated method

deprecated_method()

Do nothing (deprecated placeholder).

Shows deprecated + method badges.

Deprecated since version 1.5: Use regular_method() instead.

Return type:

None

Abstract base classes

class gp_demo_api.DemoAbstractBase

class

class

class gp_demo_api.DemoAbstractBase

Bases: ABC

Abstract base class. Shows class type badge.

Subclass this to provide concrete implementations.

abstractmethod must_implement()

abstract method

abstract method

abstractmethod must_implement()

Abstract method. Shows abstract + method badges.

Returns:

Implementation-specific value.

Return type:

str

_abc_impl = <_abc._abc_data object>

attribute

attribute

_abc_impl = <_abc._abc_data object>

abstractmethod async async_abstract()

abstract async method

abstract async method

abstractmethod async async_abstract()

Async abstract method. Shows async + abstract + method badges.

Return type:

None