stubber.publish.candidates

Module Contents

Functions

subfolder_names(path)

returns a list of names of the subfolders of the given path

version_candidates(→ Generator[str, None, None])

get a list of versions for the given family and suffix

list_frozen_ports([family, version, path])

get list of ports with frozen stubs for a given family and version

list_micropython_ports([family, mpy_path])

get list of micropython ports for a given family and version

list_micropython_port_boards(port[, family, mpy_path])

get list of micropython boards for a given family version and board

frozen_candidates(→ Generator[Dict[str, Any], None, None])

generate a list of possible firmware stubs for the given family (, version port and board) ?

docstub_candidates([family, versions, path])

generate a list of possible documentation stub candidates for the given family and version.

firmware_candidates([family, versions, mpy_path, pt])

generate a list of possible firmware stub candidates for the given family and version.

Attributes

OLDEST_VERSION

This is the oldest MicroPython version to build the stubs on

V_LATEST

stubber.publish.candidates.OLDEST_VERSION = 1.16

This is the oldest MicroPython version to build the stubs on

stubber.publish.candidates.V_LATEST = latest
stubber.publish.candidates.subfolder_names(path: pathlib.Path)

returns a list of names of the subfolders of the given path

Parameters

path (pathlib.Path) –

stubber.publish.candidates.version_candidates(suffix: str, prefix='.*', *, path=CONFIG.stub_path, oldest=OLDEST_VERSION) → Generator[str, None, None]

get a list of versions for the given family and suffix

Parameters

suffix (str) –

Return type

Generator[str, None, None]

stubber.publish.candidates.list_frozen_ports(family: str = 'micropython', version: str = V_LATEST, path=CONFIG.stub_path)

get list of ports with frozen stubs for a given family and version

Parameters

  • family (str) –

  • version (str) –

stubber.publish.candidates.list_micropython_ports(family: str = 'micropython', mpy_path=CONFIG.mpy_path)

get list of micropython ports for a given family and version

Parameters

family (str) –

stubber.publish.candidates.list_micropython_port_boards(port: str, family: str = 'micropython', mpy_path=CONFIG.mpy_path)

get list of micropython boards for a given family version and board

Parameters

  • port (str) –

  • family (str) –

stubber.publish.candidates.frozen_candidates(family: str = 'micropython', versions: Union[str, List[str]] = V_LATEST, ports: Union[str, List[str]] = 'auto', boards: Union[str, List[str]] = 'auto', *, path=CONFIG.stub_path) → Generator[Dict[str, Any], None, None]

generate a list of possible firmware stubs for the given family (, version port and board) ? - family = micropython

board and port are ignored, they are looked up from the available frozen stubs

  • versions = ‘latest’ , ‘auto’ or a list of versions

  • port = ‘auto’ or a specific port

  • board = ‘auto’ or a specific board, ‘GENERIC’ must be specified in ALLCAPS

Parameters

  • family (str) –

  • versions (Union[str, List[str]]) –

  • ports (Union[str, List[str]]) –

  • boards (Union[str, List[str]]) –

Return type

Generator[Dict[str, Any], None, None]

stubber.publish.candidates.docstub_candidates(family: str = 'micropython', versions: Union[str, List[str]] = V_LATEST, path=CONFIG.stub_path)

generate a list of possible documentation stub candidates for the given family and version.

Note that the folders do not need to exist, with the exeption of auto which will scan the stubs folder for versions of docstubs

Parameters

  • family (str) –

  • versions (Union[str, List[str]]) –

stubber.publish.candidates.firmware_candidates(family: str = 'micropython', versions: Union[str, List[str]] = V_LATEST, *, mpy_path=CONFIG.mpy_path, pt=FIRMWARE_STUBS)

generate a list of possible firmware stub candidates for the given family and version. list is basesed on the micropython repo /ports/<list of ports>/boards/<list of boards>

Parameters

  • family (str) –

  • versions (Union[str, List[str]]) –