Class Module

Represents a Python module in the AST. This class is the top-level container for Python code, including imports, functions, classes, and global code.

Hierarchy (View Summary)

AstNode
- Module

Index

Constructors

Properties

name docstring?

Methods

addImport addFunction addClass addCodeBlock write toString

Constructors

constructor

new Module(args: ModuleArgs): Module
Creates a new Python module.
Parameters
- args: ModuleArgs
  The configuration arguments
Returns Module
Overrides AstNode.constructor

Properties

`Readonly`name

name: string

The name of the module

`Optional` `Readonly`docstring

docstring?: string

The docstring for the module

Methods

addImport

addImport(importStatement: Import): void
Adds an import statement to the module.
Parameters
- importStatement: Import
  The import statement to add
Returns void

addFunction

addFunction(functionDef: FunctionDef): void
Adds a function to the module.
Parameters
- functionDef: FunctionDef
  The function to add
Returns void

addClass

addClass(classDef: ClassDef): void
Adds a class to the module.
Parameters
- classDef: ClassDef
  The class to add
Returns void

addCodeBlock

addCodeBlock(codeBlock: CodeBlock): void
Adds a global code block to the module.
Parameters
- codeBlock: CodeBlock
  The code block to add
Returns void

write

write(writer: Writer): void
Writes the module and its contents to the writer.
Parameters
- writer: Writer
  The writer to write to
Returns void
Overrides AstNode.write

toString

toString(): string
Returns the string representation of the AST node. This method creates a new Writer instance and writes the node's content to it.

Returns string
The string representation of the AST node

Inherited from AstNode.toString