Class PythonFileGenerator

Abstract file generator which each file generator much implement.

Hierarchy

PythonGenerator
- PythonFileGenerator

Implements

AbstractFileGenerator<PythonRenderCompleteModelOptions>

Constructors

constructor

new PythonFileGenerator(options?): PythonFileGenerator
Parameters
- Optional options: {
      constraints?: { enumKey?: EnumKeyConstraint<PythonOptions> | undefined; enumValue?: EnumValueConstraint<PythonOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; };
      defaultPreset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; };
      dependencyManager?: (() => PythonDependencyManager) | ({ options?: { typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, PythonOptions, PythonDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; } | undefined; ... 6 more ...; dependencyManager?: (() => PythonDependencyManager) | ... 1 more ... | undefined; ...);
      importsStyle?: "explicit" | "implicit";
      indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; };
      presets?: (undefined | ({ class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; }) | ({ preset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; } | undefined; options?: any; }))[];
      processorOptions?: { asyncapi?: { source?: string | undefined; applyTraits?: boolean | undefined; parseSchemas?: boolean | undefined; validateOptions?: { allowedSeverity?: { error?: boolean | undefined; warning?: boolean | undefined; info?: boolean | undefined; hint?: boolean | undefined; } | undefined; __unstable?: { ...; } | undefin...;
      typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, PythonOptions, PythonDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; };
  }
  - Optional constraints?: { enumKey?: EnumKeyConstraint<PythonOptions> | undefined; enumValue?: EnumValueConstraint<PythonOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; }
  - Optional defaultPreset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; }
  - Optional dependencyManager?: (() => PythonDependencyManager) | ({ options?: { typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, PythonOptions, PythonDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; } | undefined; ... 6 more ...; dependencyManager?: (() => PythonDependencyManager) | ... 1 more ... | undefined; ...)
    This dependency manager type serves two functions.
    
    It can be used to provide a factory for generate functions
    
    It can be used to provide a single instance of a dependency manager, to add all dependencies together
    
    This depends on context and where it's used.
  - Optional importsStyle?: "explicit" | "implicit"
  - Optional indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; }
  - Optional presets?: (undefined | ({ class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; }) | ({ preset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; } | undefined; options?: any; }))[]
  - Optional processorOptions?: { asyncapi?: { source?: string | undefined; applyTraits?: boolean | undefined; parseSchemas?: boolean | undefined; validateOptions?: { allowedSeverity?: { error?: boolean | undefined; warning?: boolean | undefined; info?: boolean | undefined; hint?: boolean | undefined; } | undefined; __unstable?: { ...; } | undefin...
  - Optional typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, PythonOptions, PythonDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }
Returns PythonFileGenerator
Inherited from PythonGenerator.constructor
- Defined in src/generators/python/PythonGenerator.ts:74

Properties

`Readonly` languageName

languageName: string

`Readonly` options

options: PythonOptions

`Static` defaultCompleteModelOptions

defaultCompleteModelOptions: PythonRenderCompleteModelOptions = {}

`Static` defaultOptions

defaultOptions: PythonOptions = ...

Methods

constrainToMetaModel

constrainToMetaModel(model, options): ConstrainedMetaModel
Parameters
- model: MetaModel
- options: {
      constraints?: { enumKey?: EnumKeyConstraint<PythonOptions> | undefined; enumValue?: EnumValueConstraint<PythonOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; };
      defaultPreset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; };
      dependencyManager?: (() => PythonDependencyManager) | ({ options?: { typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, PythonOptions, PythonDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; } | undefined; ... 6 more ...; dependencyManager?: (() => PythonDependencyManager) | ... 1 more ... | undefined; ...);
      importsStyle?: "explicit" | "implicit";
      indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; };
      presets?: (undefined | ({ class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; }) | ({ preset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; } | undefined; options?: any; }))[];
      processorOptions?: { asyncapi?: { source?: string | undefined; applyTraits?: boolean | undefined; parseSchemas?: boolean | undefined; validateOptions?: { allowedSeverity?: { error?: boolean | undefined; warning?: boolean | undefined; info?: boolean | undefined; hint?: boolean | undefined; } | undefined; __unstable?: { ...; } | undefin...;
      typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, PythonOptions, PythonDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; };
  }
  - Optional constraints?: { enumKey?: EnumKeyConstraint<PythonOptions> | undefined; enumValue?: EnumValueConstraint<PythonOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; }
  - Optional defaultPreset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; }
  - Optional dependencyManager?: (() => PythonDependencyManager) | ({ options?: { typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, PythonOptions, PythonDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; } | undefined; ... 6 more ...; dependencyManager?: (() => PythonDependencyManager) | ... 1 more ... | undefined; ...)
    This dependency manager type serves two functions.
    
    It can be used to provide a factory for generate functions
    
    It can be used to provide a single instance of a dependency manager, to add all dependencies together
    
    This depends on context and where it's used.
  - Optional importsStyle?: "explicit" | "implicit"
  - Optional indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; }
  - Optional presets?: (undefined | ({ class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; }) | ({ preset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; } | undefined; options?: any; }))[]
  - Optional processorOptions?: { asyncapi?: { source?: string | undefined; applyTraits?: boolean | undefined; parseSchemas?: boolean | undefined; validateOptions?: { allowedSeverity?: { error?: boolean | undefined; warning?: boolean | undefined; info?: boolean | undefined; hint?: boolean | undefined; } | undefined; __unstable?: { ...; } | undefin...
  - Optional typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, PythonOptions, PythonDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }
Returns ConstrainedMetaModel
Inherited from PythonGenerator.constrainToMetaModel
- Defined in src/generators/python/PythonGenerator.ts:117

generate

generate(input): Promise<OutputModel[]>
Generates a scattered model where dependencies and rendered results are separated.
Parameters
- input: any
Returns Promise<OutputModel[]>
Inherited from PythonGenerator.generate
- Defined in src/generators/AbstractGenerator.ts:228

generateCompleteModels

generateCompleteModels(input, completeOptions): Promise<OutputModel[]>
Generates the full output of a model, instead of a scattered model.

OutputModels result is no longer the model itself, but including package, package dependencies and model dependencies.
Parameters
- input: any
- completeOptions: Partial<PythonRenderCompleteModelOptions>
Returns Promise<OutputModel[]>
Inherited from PythonGenerator.generateCompleteModels
- Defined in src/generators/AbstractGenerator.ts:198

generateToFiles

generateToFiles(input, outputDirectory, options, ensureFilesWritten?): Promise<OutputModel[]>
Generates all the models to an output directory each model with their own separate files.
Parameters
- input: any
- outputDirectory: string
  
  where you want the models generated to
- options: PythonRenderCompleteModelOptions
- ensureFilesWritten: boolean = false
  
  verify that the files is completely written before returning, this can happen if the file system is swamped with write requests.
Returns Promise<OutputModel[]>
Implementation of AbstractFileGenerator.generateToFiles
- Defined in src/generators/python/PythonFileGenerator.ts:19

getDependencyManager

getDependencyManager(options): PythonDependencyManager
Wrapper to get an instance of the dependency manager
Parameters
- options: PythonOptions
Returns PythonDependencyManager
Inherited from PythonGenerator.getDependencyManager
- Defined in src/generators/python/PythonGenerator.ts:99

`Protected` getDependencyManagerInstance

getDependencyManagerInstance(options): AbstractDependencyManager
This function returns an instance of the dependency manager which is either a factory or an instance.
Parameters
- options: PythonOptions
Returns AbstractDependencyManager
Inherited from PythonGenerator.getDependencyManagerInstance
- Defined in src/generators/AbstractGenerator.ts:106

`Protected` getPresets

getPresets(presetType): [Partial<any>, unknown][]
Get all presets (default and custom ones from options) for a given preset type (class, enum, etc).
Parameters
- presetType: string
Returns [Partial<any>, unknown][]
Inherited from PythonGenerator.getPresets
- Defined in src/generators/AbstractGenerator.ts:280

process

process(input): Promise<InputMetaModel>
Parameters
- input: Record<string, unknown>
Returns Promise<InputMetaModel>
Inherited from PythonGenerator.process
- Defined in src/generators/AbstractGenerator.ts:96

`Protected` processInput

processInput(input): Promise<InputMetaModel>
Process any of the input formats to the appropriate InputMetaModel type and split out the meta models based on the requirements of the generators
Parameters
- input: any
Returns Promise<InputMetaModel>
Inherited from PythonGenerator.processInput
- Defined in src/generators/AbstractGenerator.ts:259

render

render(args): Promise<RenderOutput>
Render a scattered model, where the source code and library and model dependencies are separated.
Parameters
- args: AbstractGeneratorRenderArgs<PythonOptions, ConstrainedMetaModel>
Returns Promise<RenderOutput>
Inherited from PythonGenerator.render
- Defined in src/generators/python/PythonGenerator.ts:144

renderClass

renderClass(model, inputModel, options?): Promise<RenderOutput>
Parameters
- model: ConstrainedObjectModel
- inputModel: InputMetaModel
- Optional options: {
      constraints?: { enumKey?: EnumKeyConstraint<PythonOptions> | undefined; enumValue?: EnumValueConstraint<PythonOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; };
      defaultPreset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; };
      dependencyManager?: (() => PythonDependencyManager) | ({ options?: { typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, PythonOptions, PythonDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; } | undefined; ... 6 more ...; dependencyManager?: (() => PythonDependencyManager) | ... 1 more ... | undefined; ...);
      importsStyle?: "explicit" | "implicit";
      indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; };
      presets?: (undefined | ({ class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; }) | ({ preset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; } | undefined; options?: any; }))[];
      processorOptions?: { asyncapi?: { source?: string | undefined; applyTraits?: boolean | undefined; parseSchemas?: boolean | undefined; validateOptions?: { allowedSeverity?: { error?: boolean | undefined; warning?: boolean | undefined; info?: boolean | undefined; hint?: boolean | undefined; } | undefined; __unstable?: { ...; } | undefin...;
      typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, PythonOptions, PythonDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; };
  }
  - Optional constraints?: { enumKey?: EnumKeyConstraint<PythonOptions> | undefined; enumValue?: EnumValueConstraint<PythonOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; }
  - Optional defaultPreset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; }
  - Optional dependencyManager?: (() => PythonDependencyManager) | ({ options?: { typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, PythonOptions, PythonDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; } | undefined; ... 6 more ...; dependencyManager?: (() => PythonDependencyManager) | ... 1 more ... | undefined; ...)
    This dependency manager type serves two functions.
    
    It can be used to provide a factory for generate functions
    
    It can be used to provide a single instance of a dependency manager, to add all dependencies together
    
    This depends on context and where it's used.
  - Optional importsStyle?: "explicit" | "implicit"
  - Optional indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; }
  - Optional presets?: (undefined | ({ class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; }) | ({ preset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; } | undefined; options?: any; }))[]
  - Optional processorOptions?: { asyncapi?: { source?: string | undefined; applyTraits?: boolean | undefined; parseSchemas?: boolean | undefined; validateOptions?: { allowedSeverity?: { error?: boolean | undefined; warning?: boolean | undefined; info?: boolean | undefined; hint?: boolean | undefined; } | undefined; __unstable?: { ...; } | undefin...
  - Optional typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, PythonOptions, PythonDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }
Returns Promise<RenderOutput>
Inherited from PythonGenerator.renderClass
- Defined in src/generators/python/PythonGenerator.ts:219

renderCompleteModel

renderCompleteModel(args): Promise<RenderOutput>
Render a complete model result where the model code, library and model dependencies are all bundled appropriately.

For Python you need to specify which package the model is placed under.
Parameters
- args: AbstractGeneratorRenderCompleteModelArgs<PythonOptions, PythonRenderCompleteModelOptions>
Returns Promise<RenderOutput>
Inherited from PythonGenerator.renderCompleteModel
- Defined in src/generators/python/PythonGenerator.ts:185

renderEnum

renderEnum(model, inputModel, options?): Promise<RenderOutput>
Parameters
- model: ConstrainedEnumModel
- inputModel: InputMetaModel
- Optional options: {
      constraints?: { enumKey?: EnumKeyConstraint<PythonOptions> | undefined; enumValue?: EnumValueConstraint<PythonOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; };
      defaultPreset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; };
      dependencyManager?: (() => PythonDependencyManager) | ({ options?: { typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, PythonOptions, PythonDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; } | undefined; ... 6 more ...; dependencyManager?: (() => PythonDependencyManager) | ... 1 more ... | undefined; ...);
      importsStyle?: "explicit" | "implicit";
      indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; };
      presets?: (undefined | ({ class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; }) | ({ preset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; } | undefined; options?: any; }))[];
      processorOptions?: { asyncapi?: { source?: string | undefined; applyTraits?: boolean | undefined; parseSchemas?: boolean | undefined; validateOptions?: { allowedSeverity?: { error?: boolean | undefined; warning?: boolean | undefined; info?: boolean | undefined; hint?: boolean | undefined; } | undefined; __unstable?: { ...; } | undefin...;
      typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, PythonOptions, PythonDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; };
  }
  - Optional constraints?: { enumKey?: EnumKeyConstraint<PythonOptions> | undefined; enumValue?: EnumValueConstraint<PythonOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; }
  - Optional defaultPreset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; }
  - Optional dependencyManager?: (() => PythonDependencyManager) | ({ options?: { typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, PythonOptions, PythonDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; } | undefined; ... 6 more ...; dependencyManager?: (() => PythonDependencyManager) | ... 1 more ... | undefined; ...)
    This dependency manager type serves two functions.
    
    It can be used to provide a factory for generate functions
    
    It can be used to provide a single instance of a dependency manager, to add all dependencies together
    
    This depends on context and where it's used.
  - Optional importsStyle?: "explicit" | "implicit"
  - Optional indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; }
  - Optional presets?: (undefined | ({ class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; }) | ({ preset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; } | undefined; options?: any; }))[]
  - Optional processorOptions?: { asyncapi?: { source?: string | undefined; applyTraits?: boolean | undefined; parseSchemas?: boolean | undefined; validateOptions?: { allowedSeverity?: { error?: boolean | undefined; warning?: boolean | undefined; info?: boolean | undefined; hint?: boolean | undefined; } | undefined; __unstable?: { ...; } | undefin...
  - Optional typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, PythonOptions, PythonDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }
Returns Promise<RenderOutput>
Inherited from PythonGenerator.renderEnum
- Defined in src/generators/python/PythonGenerator.ts:246

splitMetaModel

splitMetaModel(model): MetaModel[]
This function makes sure we split up the MetaModels accordingly to what we want to render as models.
Parameters
- model: MetaModel
Returns MetaModel[]
Inherited from PythonGenerator.splitMetaModel
- Defined in src/generators/python/PythonGenerator.ts:108

`Static` getPythonOptions

getPythonOptions(options?): PythonOptions
Returns the Python options by merging custom options with default ones.
Parameters
- Optional options: {
      constraints?: { enumKey?: EnumKeyConstraint<PythonOptions> | undefined; enumValue?: EnumValueConstraint<PythonOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; };
      defaultPreset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; };
      dependencyManager?: (() => PythonDependencyManager) | ({ options?: { typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, PythonOptions, PythonDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; } | undefined; ... 6 more ...; dependencyManager?: (() => PythonDependencyManager) | ... 1 more ... | undefined; ...);
      importsStyle?: "explicit" | "implicit";
      indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; };
      presets?: (undefined | ({ class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; }) | ({ preset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; } | undefined; options?: any; }))[];
      processorOptions?: { asyncapi?: { source?: string | undefined; applyTraits?: boolean | undefined; parseSchemas?: boolean | undefined; validateOptions?: { allowedSeverity?: { error?: boolean | undefined; warning?: boolean | undefined; info?: boolean | undefined; hint?: boolean | undefined; } | undefined; __unstable?: { ...; } | undefin...;
      typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, PythonOptions, PythonDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; };
  }
  - Optional constraints?: { enumKey?: EnumKeyConstraint<PythonOptions> | undefined; enumValue?: EnumValueConstraint<PythonOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; }
  - Optional defaultPreset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; }
  - Optional dependencyManager?: (() => PythonDependencyManager) | ({ options?: { typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, PythonOptions, PythonDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; } | undefined; ... 6 more ...; dependencyManager?: (() => PythonDependencyManager) | ... 1 more ... | undefined; ...)
    This dependency manager type serves two functions.
    
    It can be used to provide a factory for generate functions
    
    It can be used to provide a single instance of a dependency manager, to add all dependencies together
    
    This depends on context and where it's used.
  - Optional importsStyle?: "explicit" | "implicit"
  - Optional indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; }
  - Optional presets?: (undefined | ({ class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; }) | ({ preset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; } | undefined; options?: any; }))[]
  - Optional processorOptions?: { asyncapi?: { source?: string | undefined; applyTraits?: boolean | undefined; parseSchemas?: boolean | undefined; validateOptions?: { allowedSeverity?: { error?: boolean | undefined; warning?: boolean | undefined; info?: boolean | undefined; hint?: boolean | undefined; } | undefined; __unstable?: { ...; } | undefin...
  - Optional typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, PythonOptions, PythonDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }
Returns PythonOptions
Inherited from PythonGenerator.getPythonOptions
- Defined in src/generators/python/PythonGenerator.ts:82

Class PythonFileGenerator

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional constraints?: { enumKey?: EnumKeyConstraint<PythonOptions> | undefined; enumValue?: EnumValueConstraint<PythonOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; }

Optional defaultPreset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; }

Optional importsStyle?: "explicit" | "implicit"

Optional indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; }

Optional typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, PythonOptions, PythonDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }

Returns PythonFileGenerator

Properties

Readonly languageName

Readonly options

Static defaultCompleteModelOptions

Static defaultOptions

Methods

constrainToMetaModel

Parameters

model: MetaModel

Optional constraints?: { enumKey?: EnumKeyConstraint<PythonOptions> | undefined; enumValue?: EnumValueConstraint<PythonOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; }

Optional defaultPreset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; }

Optional importsStyle?: "explicit" | "implicit"

Optional indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; }

Optional typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, PythonOptions, PythonDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }

Returns ConstrainedMetaModel

generate

Parameters

input: any

Returns Promise<OutputModel[]>

generateCompleteModels

Parameters

input: any

completeOptions: Partial<PythonRenderCompleteModelOptions>

Returns Promise<OutputModel[]>

generateToFiles

Parameters

input: any

outputDirectory: string

options: PythonRenderCompleteModelOptions

ensureFilesWritten: boolean = false

Returns Promise<OutputModel[]>

getDependencyManager

Parameters

options: PythonOptions

Returns PythonDependencyManager

Protected getDependencyManagerInstance

Parameters

options: PythonOptions

Returns AbstractDependencyManager

Protected getPresets

Parameters

presetType: string

Returns [Partial<any>, unknown][]

process

Parameters

input: Record<string, unknown>

Returns Promise<InputMetaModel>

Protected processInput

Parameters

input: any

Returns Promise<InputMetaModel>

render

Parameters

args: AbstractGeneratorRenderArgs<PythonOptions, ConstrainedMetaModel>

Returns Promise<RenderOutput>

renderClass

Parameters

model: ConstrainedObjectModel

inputModel: InputMetaModel

Optional constraints?: { enumKey?: EnumKeyConstraint<PythonOptions> | undefined; enumValue?: EnumValueConstraint<PythonOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; }

Optional defaultPreset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; }

Optional importsStyle?: "explicit" | "implicit"

Optional indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; }

Optional typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, PythonOptions, PythonDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }

`Optional` constraints?: { enumKey?: EnumKeyConstraint<PythonOptions> | undefined; enumValue?: EnumValueConstraint<PythonOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; }

`Optional` defaultPreset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; }

`Optional` importsStyle?: "explicit" | "implicit"

`Optional` indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; }

`Optional` typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, PythonOptions, PythonDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }

`Readonly` languageName

`Readonly` options

`Static` defaultCompleteModelOptions

`Static` defaultOptions

`Optional` constraints?: { enumKey?: EnumKeyConstraint<PythonOptions> | undefined; enumValue?: EnumValueConstraint<PythonOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; }

`Optional` defaultPreset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; }

`Optional` importsStyle?: "explicit" | "implicit"

`Optional` indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; }

`Optional` typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, PythonOptions, PythonDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }

`Protected` getDependencyManagerInstance

`Protected` getPresets

`Protected` processInput

`Optional` constraints?: { enumKey?: EnumKeyConstraint<PythonOptions> | undefined; enumValue?: EnumValueConstraint<PythonOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; }

`Optional` defaultPreset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; }

`Optional` importsStyle?: "explicit" | "implicit"

`Optional` indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; }

`Optional` typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, PythonOptions, PythonDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }

`Optional` constraints?: { enumKey?: EnumKeyConstraint<PythonOptions> | undefined; enumValue?: EnumValueConstraint<PythonOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; }

`Optional` defaultPreset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; }

`Optional` importsStyle?: "explicit" | "implicit"

`Optional` indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; }

`Optional` typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, PythonOptions, PythonDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }

`Static` getPythonOptions

`Optional` constraints?: { enumKey?: EnumKeyConstraint<PythonOptions> | undefined; enumValue?: EnumValueConstraint<PythonOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; }

`Optional` defaultPreset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; }

`Optional` importsStyle?: "explicit" | "implicit"

`Optional` indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; }

`Optional` typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, PythonOptions, PythonDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }