stubber.publish.pathnames

Helper functions to deal with path names and filenames for the folders in the stubs repo

Module Contents

Functions

get_base(candidate[, version])

board_folder_name(→ str)

Return the name of the firmware folder. Can be in AnyCase.

get_board_path(→ pathlib.Path)

get_merged_path(→ pathlib.Path)

stubber.publish.pathnames.get_base(candidate: Dict[str, str], version: str | None = None)
Parameters:
  • candidate (Dict[str, str]) –

  • version (Optional[str]) –

stubber.publish.pathnames.board_folder_name(fw: Dict, *, version: str | None = None) str

Return the name of the firmware folder. Can be in AnyCase.

Parameters:
  • fw (Dict) –

  • version (Optional[str]) –

Return type:

str

stubber.publish.pathnames.get_board_path(candidate: Dict) pathlib.Path
Parameters:

candidate (Dict) –

Return type:

pathlib.Path

stubber.publish.pathnames.get_merged_path(fw: Dict) pathlib.Path
Parameters:

fw (Dict) –

Return type:

pathlib.Path