Skip to content

API reference

MyExampleClass

Source code in mkdtemp/__init__.py 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
class MyExampleClass:
    def __init__(self, x: str):
        """An example class. It has one property.

        Args:
            x (str): A meaningless string-valued property.
        """
        self.x = x

    def what_is_x(self) -> str:
        """A meaningless accessor function.

        Returns:
            str: The value of this class's single property.
        """
        return self.x

__init__(x)

An example class. It has one property.

Parameters:

Name Type Description Default
x str

A meaningless string-valued property.

 required
Source code in mkdtemp/__init__.py 
2
3
4
5
6
7
8
def __init__(self, x: str):
    """An example class. It has one property.

    Args:
        x (str): A meaningless string-valued property.
    """
    self.x = x

what_is_x()

A meaningless accessor function.

Returns:

Name Type Description
str str

The value of this class's single property.
Source code in mkdtemp/__init__.py 
10
11
12
13
14
15
16
def what_is_x(self) -> str:
    """A meaningless accessor function.

    Returns:
        str: The value of this class's single property.
    """
    return self.x