Examples

Live demos

Class with members (regions + fold)

class api_demo_layout.LayoutDemo

class

class

class api_demo_layout.LayoutDemo

Bases: object

A class demonstrating all layout regions.

The class docstring forms the narrative region. The parameter field list below forms the fields region (folded if large enough). Nested methods form the members region.

Parameters (13)

Parameters:

• host (str) – Server hostname.

• port (int) – Server port number.

• username (str) – Authentication username.

• password (str) – Authentication password.

• database (str) – Database name.

• timeout (float) – Connection timeout in seconds.

• retries (int) – Number of connection retries.

• ssl (bool) – Enable SSL/TLS.

• pool_size (int) – Connection pool size.

• pool_timeout (float) – Pool checkout timeout.

• echo (bool) – Log all SQL statements.

• encoding (str) – Character encoding.

• isolation_level (str) – Transaction isolation level.

__init__(host, [...])

method

method

__init__(host, [...])

Parameters (14)

Parameters:

• host (str)

• port (int)

• username (str)

• password (str)

• database (str)

• timeout (float)

• retries (int)

• ssl (bool)

• pool_size (int)

• pool_timeout (float)

• echo (bool)

• encoding (str)

• isolation_level (str)

Return type:

None

connect()

method

method

connect()

Open a connection to the server.

Returns:

True if connection succeeded.

Return type:

bool

execute(query, params=None)

method

method

execute(query, params=None)

Execute a query and return results.

Parameters:

• query (str) – SQL query string.

• params (dict[str, str] | None) – Query parameters.

Returns:

Query result rows.

Return type:

list[dict[str, str]]

close()

method

method

close()

Close the connection.

Return type:

None

The class above renders with:

• narrative region (class docstring)

• fields region with fold (13 parameters > threshold of 10)

• members region (connect, execute, close methods)

Small function (no fold)

api_demo_layout.compact_function(name, value=0)

function

function

api_demo_layout.compact_function(name, value=0)

Format a name-value pair.

This should render without any fold – just a narrative region followed by a fields region.

Parameters:

• name (str) – The item name.

• value (int) – The item value.

Returns:

Formatted result.

Return type:

str