python

Documentation

Index

• Constants
• type Builder
  • func (jenny *Builder) Generate(context languages.Context) (codejen.Files, error)
  • func (jenny *Builder) JennyName() string
• type Config
  • func (config *Config) InterpolateParameters(interpolator func(input string) string)
• type ImportStmt
• type Language
  • func New(config Config) *Language
  • func (language *Language) CompilerPasses() compiler.Passes
  • func (language *Language) Jennies(globalConfig languages.Config) *codejen.JennyList[languages.Context]
  • func (language *Language) Name() string
  • func (language *Language) NullableKinds() languages.NullableConfig
• type ModuleImportMap
  • func NewImportMap() *ModuleImportMap
  • func NewModuleImportMap(opts ...common.ImportMapOption[ModuleImportMap]) *ModuleImportMap
  • func (im ModuleImportMap) AddModule(alias string, pkg string, module string) string
  • func (im ModuleImportMap) AddPackage(alias string, pkg string) string
  • func (im ModuleImportMap) Sort()
  • func (im ModuleImportMap) String() string
• type ModuleInit
  • func (jenny ModuleInit) Generate(context languages.Context) (codejen.Files, error)
  • func (jenny ModuleInit) JennyName() string
• type RawTypes
  • func (jenny RawTypes) Generate(context languages.Context) (codejen.Files, error)
  • func (jenny RawTypes) JennyName() string
• type Runtime
  • func (jenny Runtime) Generate(_ languages.Context) (codejen.Files, error)
  • func (jenny Runtime) JennyName() string

Constants

const LanguageRef = "python"

Types

type Builder

type Builder struct {
	// contains filtered or unexported fields
}

func (*Builder) Generate

func (jenny *Builder) Generate(context languages.Context) (codejen.Files, error)

func (*Builder) JennyName

func (jenny *Builder) JennyName() string

type Config

type Config struct {
	PathPrefix string `yaml:"path_prefix"`

	// SkipRuntime disables runtime-related code generation when enabled.
	// Note: builders can NOT be generated with this flag turned on, as they
	// rely on the runtime to function.
	SkipRuntime bool `yaml:"skip_runtime"`

	// OverridesTemplatesDirectories holds a list of directories containing templates
	// defining blocks used to override parts of builders/types/....
	OverridesTemplatesDirectories []string `yaml:"overrides_templates"`

	// ExtraFilesTemplatesDirectories holds a list of directories containing
	// templates describing files to be added to the generated output.
	ExtraFilesTemplatesDirectories []string `yaml:"extra_files_templates"`

	// ExtraFilesTemplatesData holds additional data to be injected into the
	// templates described in ExtraFilesTemplatesDirectories.
	ExtraFilesTemplatesData map[string]string `yaml:"-"`
}

func (*Config) InterpolateParameters

func (config *Config) InterpolateParameters(interpolator func(input string) string)

type ImportStmt

type ImportStmt struct {
	Package string
	Module  string
}

type Language

type Language struct {
	// contains filtered or unexported fields
}

func New

func New(config Config) *Language

func (*Language) CompilerPasses

func (language *Language) CompilerPasses() compiler.Passes

func (*Language) Jennies

func (language *Language) Jennies(globalConfig languages.Config) *codejen.JennyList[languages.Context]

func (*Language) Name

func (language *Language) Name() string

func (*Language) NullableKinds

func (language *Language) NullableKinds() languages.NullableConfig

type ModuleImportMap

type ModuleImportMap struct {
	// alias → ImportStmt
	Imports *orderedmap.Map[string, ImportStmt]
	// contains filtered or unexported fields
}

func NewImportMap

func NewImportMap() *ModuleImportMap

func NewModuleImportMap

func NewModuleImportMap(opts ...common.ImportMapOption[ModuleImportMap]) *ModuleImportMap

func (ModuleImportMap) AddModule

func (im ModuleImportMap) AddModule(alias string, pkg string, module string) string

func (ModuleImportMap) AddPackage

func (im ModuleImportMap) AddPackage(alias string, pkg string) string

func (ModuleImportMap) Sort

func (im ModuleImportMap) Sort()

func (ModuleImportMap) String

func (im ModuleImportMap) String() string

type ModuleInit

type ModuleInit struct {
}

func (ModuleInit) Generate

func (jenny ModuleInit) Generate(context languages.Context) (codejen.Files, error)

func (ModuleInit) JennyName

func (jenny ModuleInit) JennyName() string

type RawTypes

type RawTypes struct {
	// contains filtered or unexported fields
}

func (RawTypes) Generate

func (jenny RawTypes) Generate(context languages.Context) (codejen.Files, error)

func (RawTypes) JennyName

func (jenny RawTypes) JennyName() string

type Runtime

type Runtime struct {
	// contains filtered or unexported fields
}

func (Runtime) Generate

func (jenny Runtime) Generate(_ languages.Context) (codejen.Files, error)

func (Runtime) JennyName

func (jenny Runtime) JennyName() string