Skip to content

Emitter usage

Usage

Section titled “Usage”
  1. Via the command line
Terminal window
tsp compile . --emit=@azure-tools/typespec-python
  1. Via the config
emit:
  - "@azure-tools/typespec-python"

The config can be extended with options as follows:

emit:
  - "@azure-tools/typespec-python"
options:
  "@azure-tools/typespec-python":
    option: value

Emitter options

Section titled “Emitter options”

emitter-output-dir

Section titled “emitter-output-dir”

Type: absolutePath

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

examples-dir

Section titled “examples-dir”

Type: string

Specifies the directory where the emitter will look for example files. If the flag isn’t set, the emitter defaults to using an examples directory located at the project root.

namespace

Section titled “namespace”

Type: string

Specifies the namespace you want to override for namespaces set in the spec. With this config, all namespace for the spec types will default to it.

flavor

Section titled “flavor”

Type: string

The flavor of the SDK.

models-mode

Section titled “models-mode”

Type: "dpg" | "none"

What kind of models to generate. If you pass in none, we won’t generate models. dpg models are the default models we generate.

generate-sample

Section titled “generate-sample”

Type: boolean

Whether to generate sample files, for basic samples of your generated sdks. Defaults to false.

generate-test

Section titled “generate-test”

Type: boolean

Whether to generate test files, for basic testing of your generated sdks. Defaults to false.

api-version

Section titled “api-version”

Type: string

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.

license

Section titled “license”

Type: object

License information for the generated client code.

package-version

Section titled “package-version”

Type: string

The version of the package.

package-name

Section titled “package-name”

Type: string

The name of the package.

generate-packaging-files

Section titled “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

Section titled “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

Section titled “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

Section titled “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

Section titled “head-as-boolean”

Type: boolean

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

use-pyodide

Section titled “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.