Emitter usage

Via the command line

tsp compile . --emit=@typespec/http-client-python

Via the config

emit:
  - "@typespec/http-client-python"

The config can be extended with options as follows:

emit:
  - "@typespec/http-client-python"
options:
  "@typespec/http-client-python":
    option: value

Emitter options

`emitter-output-dir`

Type: absolutePath

Defines the emitter output directory. Defaults to {output-dir}/@typespec/http-client-python See Configuring output directory for more info

`api-version`

Type: undefined

Use this flag if you would like to generate the sdk only for a specific version. Default value is the latest version. Also accepts values latest and all. For multi-service packages, provide a map from each service namespace’s full name to its desired version; services not listed default to their latest version.

`license`

Type: object

License information for the generated client code.

`package-version`

Type: string

The version of the package.

`package-name`

Type: string

The name of the package.

`generate-packaging-files`

Type: boolean

Whether to generate packaging files. Packaging files refer to the setup.py, README, and other files that are needed to package your code.

`packaging-files-dir`

Type: string

If you are using a custom packaging files directory, you can specify it here. We won’t generate with the default packaging files we have.

`packaging-files-config`

Type: object

If you are using a custom packaging files directory, and have additional configuration parameters you want to pass in during generation, you can specify it here. Only applicable if packaging-files-dir is set.

`package-pprint-name`

Type: string

The name of the package to be used in pretty-printing. Will be the name of the package in README and pprinting of setup.py.

`head-as-boolean`

Type: boolean

Whether to return responses from HEAD requests as boolean. Defaults to true.

`use-pyodide`

Type: boolean

Whether to generate using pyodide instead of python. If there is no python installed on your device, we will default to using pyodide to generate the code.

`validate-versioning`

Type: boolean

Whether to validate the versioning of the package. Defaults to true. If set to false, we will not validate the versioning of the package.

`generation-subdir`

Type: string

The subdirectory (relative to the package namespace folder) to generate the code in. Use this to keep emitter-generated code separate from hand-written/customized code, so regeneration only overwrites the subdirectory and leaves your customizations untouched. If not specified, the code is generated directly in the package namespace folder. Note: if you’re using this flag, you will need to add and maintain the versioning file (_version.py) yourself.

Example: for namespace: azure.storage.blob with generation-subdir: _generated, generated code lands in azure/storage/blob/_generated/ while your customized code lives in azure/storage/blob/. A typical tspconfig.yaml looks like:

options:
  "@azure-tools/typespec-python":
    emitter-output-dir: "{output-dir}/{service-dir}/azure-storage-blob"
    namespace: "azure.storage.blob"
    generation-subdir: "_generated"

`keep-setup-py`

Type: boolean

Whether to keep the existing setup.py when generate-packaging-files is true. If set to false and by default, pyproject.toml will be generated instead. To generate setup.py, use basic-setup-py.

`generate-typeddict`

Type: boolean

Whether to generate TypedDict request-body overloads in models-mode: dpg. Defaults to true.

`keep-pyproject-fields`

Type: object

Which manually customized [project] fields to preserve in an existing pyproject.toml instead of overwriting them on regeneration. Set a field to true to keep it. By default no fields are preserved.

`clear-output-folder`

Type: boolean

Whether to clear the output folder before generating the code. Defaults to false.

`emit-yaml-only`

Type: boolean

Emit YAML code model only, without running Python generator. For batch processing.