PythonProjectOptions.Jsii$Proxy (io.github.cdklabs:projen 0.45.3 API)

java.lang.Object
- software.amazon.jsii.JsiiObject
- - io.github.cdklabs.projen.python.PythonProjectOptions.Jsii$Proxy

All Implemented Interfaces:

GitHubProjectOptions, ProjectOptions, PythonPackagingOptions, PythonProjectOptions, software.amazon.jsii.JsiiSerializable

Enclosing interface:

PythonProjectOptions
```
@Stability(value=Experimental)
 @Internal
public static final class PythonProjectOptions.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements PythonProjectOptions
```
An implementation for PythonProjectOptions

Nested Class Summary
- Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
  software.amazon.jsii.JsiiObject.InitializationMode
- Nested classes/interfaces inherited from interface io.github.cdklabs.projen.python.PythonProjectOptions
  PythonProjectOptions.Builder, PythonProjectOptions.Jsii$Proxy

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)` Constructor that initializes the object based on values retrieved from the JsiiObject.
`protected`	`Jsii$Proxy(PythonProjectOptions.Builder builder)` Constructor that initializes the object based on literal property values passed by the `PythonProjectOptions.Builder`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.fasterxml.jackson.databind.JsonNode`	`$jsii$toJson()`
`boolean`	`equals(Object o)`
`String`	`getAuthorEmail()` (experimental) Author's e-mail.
`String`	`getAuthorName()` (experimental) Author's name.
`AutoApproveOptions`	`getAutoApproveOptions()` (experimental) Enable and configure the 'auto approve' workflow.
`AutoMergeOptions`	`getAutoMergeOptions()` (experimental) Configure options for automatic merging on GitHub.
`List<String>`	`getClassifiers()` (experimental) A list of PyPI trove classifiers that describe the project.
`Boolean`	`getClobber()` (experimental) Add a `clobber` task which resets the repo to origin.
`List<String>`	`getDeps()` (experimental) List of runtime dependencies for this project.
`String`	`getDescription()` (experimental) A short description of the package.
`Boolean`	`getDevContainer()` (experimental) Add a VSCode development environment (used for GitHub Codespaces).
`List<String>`	`getDevDeps()` (experimental) List of dev dependencies for this project.
`Boolean`	`getGithub()` (experimental) Enable GitHub integration.
`GitHubOptions`	`getGithubOptions()` (experimental) Options for GitHub integration.
`Boolean`	`getGitpod()` (experimental) Add a Gitpod development environment.
`String`	`getHomepage()` (experimental) A URL to the website of the project.
`String`	`getLicense()` (experimental) License of this package as an SPDX identifier.
`LoggerOptions`	`getLogging()` (experimental) Configure logging options such as verbosity.
`Boolean`	`getMergify()` (deprecated) Whether mergify should be enabled on this repository or not.
`MergifyOptions`	`getMergifyOptions()` (deprecated) Options for mergify.
`String`	`getModuleName()` (experimental) Name of the python package as used in imports and filenames.
`String`	`getName()` (experimental) This is the name of your project.
`String`	`getOutdir()` (experimental) The root directory of the project.
`Project`	`getParent()` (experimental) The parent project, if this project is part of a bigger project.
`Boolean`	`getPip()` (experimental) Use pip with a requirements.txt file to track project dependencies.
`Boolean`	`getPoetry()` (experimental) Use poetry to manage your project dependencies, virtual environment, and (optional) packaging/publishing.
`PoetryPyprojectOptionsWithoutDeps`	`getPoetryOptions()` (experimental) Additional options to set for poetry if using poetry.
`ProjectType`	`getProjectType()` (deprecated) Which type of project this is (library/app).
`String`	`getProjenCommand()` (experimental) The shell command to use in order to run the projen CLI.
`Boolean`	`getProjenrcJson()` (experimental) Generate (once) .projenrc.json (in JSON).
`ProjenrcOptions`	`getProjenrcJsonOptions()` (experimental) Options for .projenrc.json.
`Boolean`	`getProjenrcPython()` (experimental) Use projenrc in python.
`ProjenrcOptions`	`getProjenrcPythonOptions()` (experimental) Options related to projenrc in python.
`Boolean`	`getPytest()` (experimental) Include pytest tests.
`PytestOptions`	`getPytestOptions()` (experimental) pytest options.
`SampleReadmeProps`	`getReadme()` (experimental) The README setup.
`Boolean`	`getSample()` (experimental) Include sample code and test if the relevant directories don't exist.
`Map<String,Object>`	`getSetupConfig()` (experimental) Additional fields to pass in the setup() function if using setuptools.
`Boolean`	`getSetuptools()` (experimental) Use setuptools with a setup.py script for packaging and publishing.
`Boolean`	`getStale()` (experimental) Auto-close of stale issues and pull request.
`StaleOptions`	`getStaleOptions()` (experimental) Auto-close stale issues and pull requests.
`Boolean`	`getVenv()` (experimental) Use venv to manage a virtual environment for installing dependencies inside.
`VenvOptions`	`getVenvOptions()` (experimental) Venv options.
`String`	`getVersion()` (experimental) Version of the package.
`Boolean`	`getVscode()` (experimental) Enable VSCode integration.
`int`	`hashCode()`

Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.github.cdklabs.projen.python.PythonProjectOptions
builder

- Constructor Detail
  - Jsii$Proxy
```
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
```
    Constructor that initializes the object based on values retrieved from the JsiiObject.
    
    Parameters:
    
    objRef - Reference to the JSII managed object.
  - Jsii$Proxy
```
protected Jsii$Proxy(PythonProjectOptions.Builder builder)
```
    Constructor that initializes the object based on literal property values passed by the PythonProjectOptions.Builder.
- Method Detail
  - getModuleName
```
public final String getModuleName()
```
    Description copied from interface: PythonProjectOptions
    
    (experimental) Name of the python package as used in imports and filenames.
    Must only consist of alphanumeric characters and underscores.
    Default: $PYTHON_MODULE_NAME
    
    Specified by:
    
    getModuleName in interface PythonProjectOptions
  - getDeps
```
public final List<String> getDeps()
```
    Description copied from interface: PythonProjectOptions
    
    (experimental) List of runtime dependencies for this project.
    Dependencies use the format: <module>@<semver>
    Additional dependencies can be added via project.addDependency().
    Default: []
    
    Specified by:
    
    getDeps in interface PythonProjectOptions
  - getDevDeps
```
public final List<String> getDevDeps()
```
    Description copied from interface: PythonProjectOptions
    
    (experimental) List of dev dependencies for this project.
    Dependencies use the format: <module>@<semver>
    Additional dependencies can be added via project.addDevDependency().
    Default: []
    
    Specified by:
    
    getDevDeps in interface PythonProjectOptions
  - getPip
```
public final Boolean getPip()
```
    Description copied from interface: PythonProjectOptions
    
    (experimental) Use pip with a requirements.txt file to track project dependencies.
    Default: true
    
    Specified by:
    
    getPip in interface PythonProjectOptions
  - getPoetry
```
public final Boolean getPoetry()
```
    Description copied from interface: PythonProjectOptions
    
    (experimental) Use poetry to manage your project dependencies, virtual environment, and (optional) packaging/publishing.
    Default: false
    
    Specified by:
    
    getPoetry in interface PythonProjectOptions
  - getProjenrcPython
```
public final Boolean getProjenrcPython()
```
    Description copied from interface: PythonProjectOptions
    
    (experimental) Use projenrc in python.
    This will install projen as a python dependency and will add a synth task which will run .projenrc.py.
    Default: true
    
    Specified by:
    
    getProjenrcPython in interface PythonProjectOptions
  - getProjenrcPythonOptions
```
public final ProjenrcOptions getProjenrcPythonOptions()
```
    Description copied from interface: PythonProjectOptions
    
    (experimental) Options related to projenrc in python.
    Default: - default options
    
    Specified by:
    
    getProjenrcPythonOptions in interface PythonProjectOptions
  - getPytest
```
public final Boolean getPytest()
```
    Description copied from interface: PythonProjectOptions
    
    (experimental) Include pytest tests.
    Default: true
    
    Specified by:
    
    getPytest in interface PythonProjectOptions
  - getPytestOptions
```
public final PytestOptions getPytestOptions()
```
    Description copied from interface: PythonProjectOptions
    
    (experimental) pytest options.
    Default: - defaults
    
    Specified by:
    
    getPytestOptions in interface PythonProjectOptions
  - getSample
```
public final Boolean getSample()
```
    Description copied from interface: PythonProjectOptions
    
    (experimental) Include sample code and test if the relevant directories don't exist.
    Default: true
    
    Specified by:
    
    getSample in interface PythonProjectOptions
  - getSetuptools
```
public final Boolean getSetuptools()
```
    Description copied from interface: PythonProjectOptions
    
    (experimental) Use setuptools with a setup.py script for packaging and publishing.
    Default: - true if the project type is library
    
    Specified by:
    
    getSetuptools in interface PythonProjectOptions
  - getVenv
```
public final Boolean getVenv()
```
    Description copied from interface: PythonProjectOptions
    
    (experimental) Use venv to manage a virtual environment for installing dependencies inside.
    Default: true
    
    Specified by:
    
    getVenv in interface PythonProjectOptions
  - getVenvOptions
```
public final VenvOptions getVenvOptions()
```
    Description copied from interface: PythonProjectOptions
    
    (experimental) Venv options.
    Default: - defaults
    
    Specified by:
    
    getVenvOptions in interface PythonProjectOptions
  - getAutoApproveOptions
```
public final AutoApproveOptions getAutoApproveOptions()
```
    Description copied from interface: GitHubProjectOptions
    
    (experimental) Enable and configure the 'auto approve' workflow.
    Default: - auto approve is disabled
    
    Specified by:
    
    getAutoApproveOptions in interface GitHubProjectOptions
  - getAutoMergeOptions
```
public final AutoMergeOptions getAutoMergeOptions()
```
    Description copied from interface: GitHubProjectOptions
    
    (experimental) Configure options for automatic merging on GitHub.
    Has no effect if github.mergify is set to false.
    Default: - see defaults in `AutoMergeOptions`
    
    Specified by:
    
    getAutoMergeOptions in interface GitHubProjectOptions
  - getClobber
```
public final Boolean getClobber()
```
    Description copied from interface: GitHubProjectOptions
    
    (experimental) Add a `clobber` task which resets the repo to origin.
    Default: true
    
    Specified by:
    
    getClobber in interface GitHubProjectOptions
  - getDevContainer
```
public final Boolean getDevContainer()
```
    Description copied from interface: GitHubProjectOptions
    
    (experimental) Add a VSCode development environment (used for GitHub Codespaces).
    Default: false
    
    Specified by:
    
    getDevContainer in interface GitHubProjectOptions
  - getGithub
```
public final Boolean getGithub()
```
    Description copied from interface: GitHubProjectOptions
    
    (experimental) Enable GitHub integration.
    Enabled by default for root projects. Disabled for non-root projects.
    Default: true
    
    Specified by:
    
    getGithub in interface GitHubProjectOptions
  - getGithubOptions
```
public final GitHubOptions getGithubOptions()
```
    Description copied from interface: GitHubProjectOptions
    
    (experimental) Options for GitHub integration.
    Default: - see GitHubOptions
    
    Specified by:
    
    getGithubOptions in interface GitHubProjectOptions
  - getGitpod
```
public final Boolean getGitpod()
```
    Description copied from interface: GitHubProjectOptions
    
    (experimental) Add a Gitpod development environment.
    Default: false
    
    Specified by:
    
    getGitpod in interface GitHubProjectOptions
  - getMergify
```
public final Boolean getMergify()
```
    Description copied from interface: GitHubProjectOptions
    
    (deprecated) Whether mergify should be enabled on this repository or not.
    Default: true
    
    Specified by:
    
    getMergify in interface GitHubProjectOptions
  - getMergifyOptions
```
public final MergifyOptions getMergifyOptions()
```
    Description copied from interface: GitHubProjectOptions
    
    (deprecated) Options for mergify.
    Default: - default options
    
    Specified by:
    
    getMergifyOptions in interface GitHubProjectOptions
  - getProjectType
```
public final ProjectType getProjectType()
```
    Description copied from interface: GitHubProjectOptions
    
    (deprecated) Which type of project this is (library/app).
    Default: ProjectType.UNKNOWN
    
    Specified by:
    
    getProjectType in interface GitHubProjectOptions
  - getReadme
```
public final SampleReadmeProps getReadme()
```
    Description copied from interface: GitHubProjectOptions
    (experimental) The README setup.
    Default: - { filename: 'README.md', contents: '# replace this' }
    Example:
    // Example automatically generated from non-compiling source. May contain errors. "{ filename: 'readme.md', contents: '# title' }"
    Specified by:
    
    getReadme in interface GitHubProjectOptions
  - getStale
```
public final Boolean getStale()
```
    Description copied from interface: GitHubProjectOptions
    
    (experimental) Auto-close of stale issues and pull request.
    See staleOptions for options.
    Default: true
    
    Specified by:
    
    getStale in interface GitHubProjectOptions
  - getStaleOptions
```
public final StaleOptions getStaleOptions()
```
    Description copied from interface: GitHubProjectOptions
    
    (experimental) Auto-close stale issues and pull requests.
    To disable set stale to false.
    Default: - see defaults in `StaleOptions`
    
    Specified by:
    
    getStaleOptions in interface GitHubProjectOptions
  - getVscode
```
public final Boolean getVscode()
```
    Description copied from interface: GitHubProjectOptions
    
    (experimental) Enable VSCode integration.
    Enabled by default for root projects. Disabled for non-root projects.
    Default: true
    
    Specified by:
    
    getVscode in interface GitHubProjectOptions
  - getName
```
public final String getName()
```
    Description copied from interface: ProjectOptions
    
    (experimental) This is the name of your project.
    Default: $BASEDIR
    
    Specified by:
    
    getName in interface ProjectOptions
  - getLogging
```
public final LoggerOptions getLogging()
```
    Description copied from interface: ProjectOptions
    
    (experimental) Configure logging options such as verbosity.
    Default: {}
    
    Specified by:
    
    getLogging in interface ProjectOptions
  - getOutdir
```
public final String getOutdir()
```
    Description copied from interface: ProjectOptions
    
    (experimental) The root directory of the project.
    Relative to this directory, all files are synthesized.
    If this project has a parent, this directory is relative to the parent directory and it cannot be the same as the parent or any of it's other sub-projects.
    Default: "."
    
    Specified by:
    
    getOutdir in interface ProjectOptions
  - getParent
```
public final Project getParent()
```
    Description copied from interface: ProjectOptions
    
    (experimental) The parent project, if this project is part of a bigger project.
    
    Specified by:
    
    getParent in interface ProjectOptions
  - getProjenCommand
```
public final String getProjenCommand()
```
    Description copied from interface: ProjectOptions
    
    (experimental) The shell command to use in order to run the projen CLI.
    Can be used to customize in special environments.
    Default: "npx projen"
    
    Specified by:
    
    getProjenCommand in interface ProjectOptions
  - getProjenrcJson
```
public final Boolean getProjenrcJson()
```
    Description copied from interface: ProjectOptions
    
    (experimental) Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.
    Default: false
    
    Specified by:
    
    getProjenrcJson in interface ProjectOptions
  - getProjenrcJsonOptions
```
public final ProjenrcOptions getProjenrcJsonOptions()
```
    Description copied from interface: ProjectOptions
    
    (experimental) Options for .projenrc.json.
    Default: - default options
    
    Specified by:
    
    getProjenrcJsonOptions in interface ProjectOptions
  - getAuthorEmail
```
public final String getAuthorEmail()
```
    Description copied from interface: PythonPackagingOptions
    
    (experimental) Author's e-mail.
    Default: $GIT_USER_EMAIL
    
    Specified by:
    
    getAuthorEmail in interface PythonPackagingOptions
  - getAuthorName
```
public final String getAuthorName()
```
    Description copied from interface: PythonPackagingOptions
    
    (experimental) Author's name.
    Default: $GIT_USER_NAME
    
    Specified by:
    
    getAuthorName in interface PythonPackagingOptions
  - getVersion
```
public final String getVersion()
```
    Description copied from interface: PythonPackagingOptions
    
    (experimental) Version of the package.
    Default: "0.1.0"
    
    Specified by:
    
    getVersion in interface PythonPackagingOptions
  - getClassifiers
```
public final List<String> getClassifiers()
```
    Description copied from interface: PythonPackagingOptions
    
    (experimental) A list of PyPI trove classifiers that describe the project.
    
    Specified by:
    
    getClassifiers in interface PythonPackagingOptions
    
    See Also:
    
    https://pypi.org/classifiers/
  - getDescription
```
public final String getDescription()
```
    Description copied from interface: PythonPackagingOptions
    
    (experimental) A short description of the package.
    
    Specified by:
    
    getDescription in interface PythonPackagingOptions
  - getHomepage
```
public final String getHomepage()
```
    Description copied from interface: PythonPackagingOptions
    
    (experimental) A URL to the website of the project.
    
    Specified by:
    
    getHomepage in interface PythonPackagingOptions
  - getLicense
```
public final String getLicense()
```
    Description copied from interface: PythonPackagingOptions
    
    (experimental) License of this package as an SPDX identifier.
    
    Specified by:
    
    getLicense in interface PythonPackagingOptions
  - getPoetryOptions
```
public final PoetryPyprojectOptionsWithoutDeps getPoetryOptions()
```
    Description copied from interface: PythonPackagingOptions
    
    (experimental) Additional options to set for poetry if using poetry.
    
    Specified by:
    
    getPoetryOptions in interface PythonPackagingOptions
  - getSetupConfig
```
public final Map<String,Object> getSetupConfig()
```
    Description copied from interface: PythonPackagingOptions
    
    (experimental) Additional fields to pass in the setup() function if using setuptools.
    
    Specified by:
    
    getSetupConfig in interface PythonPackagingOptions
  - $jsii$toJson
```
@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
```
    Specified by:
    
    $jsii$toJson in interface software.amazon.jsii.JsiiSerializable
  - equals
```
public final boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class PythonProjectOptions.Jsii$Proxy

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

Nested classes/interfaces inherited from interface io.github.cdklabs.projen.python.PythonProjectOptions

Constructor Summary

Method Summary

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Methods inherited from interface io.github.cdklabs.projen.python.PythonProjectOptions

Constructor Detail

Jsii$Proxy

Jsii$Proxy

Method Detail

getModuleName

getDeps

getDevDeps

getPip

getPoetry

getProjenrcPython

getProjenrcPythonOptions

getPytest

getPytestOptions

getSample

getSetuptools

getVenv

getVenvOptions

getAutoApproveOptions

getAutoMergeOptions

getClobber

getDevContainer

getGithub

getGithubOptions

getGitpod

getMergify

getMergifyOptions

getProjectType

getReadme

getStale

getStaleOptions

getVscode

getName

getLogging

getOutdir

getParent

getProjenCommand

getProjenrcJson

getProjenrcJsonOptions

getAuthorEmail

getAuthorName

getVersion

getClassifiers

getDescription

getHomepage

getLicense

getPoetryOptions

getSetupConfig

$jsii$toJson

equals

hashCode