AutoTransform (autotransform)¶
AutoTransform is a framework for defining and running code transformations. It can be used by organizations looking to update/change/cleanup their codebases as well as by library authors to provide transformations to end users that can be used to update code for changes to the library (i.e. moving to new APIs).
For more information, see the README.
Core¶
- Schema Package (autotransform.schema)
- AutoTransformSchema (autotransform.schema.schema)
AutoTransformSchema
AutoTransformSchema.input
AutoTransformSchema.batcher
AutoTransformSchema.transformer
AutoTransformSchema.config
AutoTransformSchema.filters
AutoTransformSchema.validators
AutoTransformSchema.commands
AutoTransformSchema.repo
AutoTransformSchema.batcher
AutoTransformSchema.commands
AutoTransformSchema.config
AutoTransformSchema.execute_batch()
AutoTransformSchema.filters
AutoTransformSchema.from_console()
AutoTransformSchema.from_data()
AutoTransformSchema.get_batches()
AutoTransformSchema.input
AutoTransformSchema.repo
AutoTransformSchema.run()
AutoTransformSchema.transformer
AutoTransformSchema.validators
- Config (autotransform.schema.config)
- SchemaBuilder (autotransform.schema.builder)
- AutoTransformSchema (autotransform.schema.schema)
- Scripts (autotransform.scripts)
- Main Script (autotransform.scripts.main)
- Init Command (autotransform.scripts.commands.initialize)
- Settings Command (autotransform.scripts.commands.settings)
- Run Command (autotransform.scripts.commands.run)
- Update Command (autotransform.scripts.commands.update)
- Schedule Command (autotransform.scripts.commands.schedule)
- Manage Command (autotransform.scripts.commands.manage)
- Available Migrations
- Config Package (autotransform.config)
get_config()
get_cwd_config_dir()
get_repo_config_dir()
get_repo_config_relative_path()
- Config (autotransform.config.config)
Config
Config.component_directory
Config.github_token
Config.github_base_url
Config.jenkins_user
Config.jenkins_token
Config.jenkins_base_url
Config.local_runner
Config.remote_runner
Config.repo_override
Config.component_directory
Config.from_console()
Config.from_data()
Config.from_json()
Config.get_component_directory_from_console()
Config.get_github_base_url_from_console()
Config.get_github_token_from_console()
Config.get_jenkins_base_url_from_console()
Config.get_jenkins_token_from_console()
Config.get_jenkins_user_from_console()
Config.get_local_runner_from_console()
Config.get_remote_runner_from_console()
Config.get_repo_override_from_console()
Config.github_base_url
Config.github_token
Config.jenkins_base_url
Config.jenkins_token
Config.jenkins_user
Config.local_runner
Config.merge()
Config.read()
Config.remote_runner
Config.repo_override
Config.write()
- ConfigFetcher (autotransform.config.fetcher)
- DefaultConfigFetcher (autotransform.config.default)
- EnvironmentConfigFetcher (autotransform.config.environment)
- Runner Package (autotransform.runner)
- Runner (autotransform.runner.base)
- GithubRunner (autotransform.runner.github)
GithubRunner
GithubRunner.run_workflow
GithubRunner.update_workflow
GithubRunner.repo_name
GithubRunner.repo_ref
GithubRunner.target_repo_name
GithubRunner.target_repo_ref
GithubRunner.name
GithubRunner.name
GithubRunner.repo_name
GithubRunner.repo_ref
GithubRunner.run()
GithubRunner.run_workflow
GithubRunner.target_repo_name
GithubRunner.target_repo_ref
GithubRunner.update()
GithubRunner.update_workflow
- JenkinsRunner (autotransform.runner.jenkins)
- LocalRunner (autotransform.runner.local)
- Item Package (autotransform.item)
- Change Package (autotransform.change)
- Change (autotransform.change.base)
Change
Change.name
Change.abandon()
Change.add_labels()
Change.add_reviewers()
Change.comment()
Change.get_batch()
Change.get_created_timestamp()
Change.get_labels()
Change.get_last_updated_timestamp()
Change.get_mergeable_state()
Change.get_review_state()
Change.get_reviewers()
Change.get_schema()
Change.get_schema_name()
Change.get_state()
Change.get_team_reviewers()
Change.get_test_state()
Change.merge()
Change.name
Change.remove_label()
Change.update()
ChangeName
ChangeState
ReviewState
TestState
- GithubChange (autotransform.change.github)
GithubChange
GithubChange.full_github_name
GithubChange.pull_number
GithubChange.name
GithubChange.abandon()
GithubChange.add_labels()
GithubChange.add_reviewers()
GithubChange.comment()
GithubChange.full_github_name
GithubChange.get_batch()
GithubChange.get_created_timestamp()
GithubChange.get_labels()
GithubChange.get_last_updated_timestamp()
GithubChange.get_mergeable_state()
GithubChange.get_review_state()
GithubChange.get_reviewers()
GithubChange.get_schema()
GithubChange.get_schema_name()
GithubChange.get_state()
GithubChange.get_team_reviewers()
GithubChange.get_test_state()
GithubChange.merge()
GithubChange.name
GithubChange.pull_number
GithubChange.remove_label()
- Change (autotransform.change.base)
- Step Package (autotransform.step)
- Step (autotransform.step.base)
- Actions (autotransform.step.action)
- Action (autotransform.step.action.base)
- Comment Actions (autotransform.step.action.comments)
- Label Actions (autotransform.step.action.labels)
- RequestAction (autotransform.step.action.request)
- Reviewer Actions (autotransform.step.action.reviewers)
- Source Control Actions (autotransform.step.action.source)
- ConditionalStep (autotransform.step.conditional)
- Conditions
- Condition (autotransform.step.condition.base)
- Comparison (autotransform.step.condition.comparison)
- AggregateCondition (autotransform.step.condition.aggregate)
- Created Time Conditions (autotransform.step.condition.created)
- Request Conditions (autotransform.step.condition.request)
- Reviewers Conditions (autotransform.step.condition.reviewers)
- Schema Conditions (autotransform.step.condition.schema)
- ChangeStateCondition (autotransform.step.condition.state)
- Updated Time Conditions (autotransform.step.condition.updated)
- ConditionalStep
- Conditions
- Event Package (autotransform.event)
- EventHandler (autotransform.event.handler)
- Event (autotransform.event.base)
- LoggingLevel (autotransform.event.logginglevel)
- EventType (autotransform.event.type)
- ManageActionEvent (autotransform.event.action)
- DebugEvent (autotransform.event.debug)
- RemoteRunEvent (autotransform.event.remoterun)
- ScriptRunEvent (autotransform.event.run)
- ScheduleRunEvent (autotransform.event.schedulerun)
- RemoteUpdateEvent (autotransform.event.update)
- DebugEvent (autotransform.event.debug)
- WarningEvent (autotransform.event.warning)
- Utilities (autotransform.util)
- Utilities
- CachedFile (autotransform.util.cachedfile)
- Component (autotransform.util.component)
- Console Functions (autotransform.util.console)
- Util Enums (autotransform.util.enums)
- Utility Functions (autotransform.util.functions)
- GithubUtils (autotransform.util.github)
- Manager (autotransform.util.manager)
- Package Functions (autotransform.util.package)
- RequestHandler (autotransform.util.request)
- Scheduler (autotransform.util.scheduler)
- SchemaMap (autotransform.util.request)
- Utilities
Schema Components¶
- Input Package (autotransform.input)
- Filter Package (autotransform.filter)
- Batcher Package (autotransform.batcher)
- Batcher (autotransform.batcher.base)
- ChunkBatcher (autotransform.batcher.chunk)
- CodeownersBatcher (autotransform.batcher.codeowners)
- DirectoryBatcher (autotransform.batcher.directory)
- ExtraDataBatcher (autotransform.batcher.extradata)
- FileRegexBatcher (autotransform.batcher.regex)
- SingleBatcher (autotransform.batcher.single)
- Transformer Package (autotransform.transformer)
- Transformer (autotransform.transformer.base)
- SingleTransformer (autotransform.transformer.single)
- JSCodeshiftTransformer (autotransform.transformer.jscodeshift)
- LibCSTTransformer (autotransform.transformer.libcst)
- RegexTransformer (autotransform.transformer.regex)
- ScriptTransformer (autotransform.transformer.script)
ScriptTransformer
ScriptTransformer.args
ScriptTransformer.script
ScriptTransformer.timeout
ScriptTransformer.chunk_size
ScriptTransformer.name
ScriptTransformer.args
ScriptTransformer.chunk_size
ScriptTransformer.chunk_size_must_be_positive()
ScriptTransformer.name
ScriptTransformer.per_item_legacy_setting_validator()
ScriptTransformer.script
ScriptTransformer.timeout
ScriptTransformer.transform()
- Validator Package (autotransform.validator)
- Validator (autotransform.validator.base)
- ScriptValidator (autotransform.validator.script)
ScriptValidator
ScriptValidator.args
ScriptValidator.script
ScriptValidator.failure_level
ScriptValidator.per_item
ScriptValidator.run_on_changes
ScriptValidator.name
ScriptValidator.args
ScriptValidator.check()
ScriptValidator.failure_level
ScriptValidator.name
ScriptValidator.per_item
ScriptValidator.run_on_changes
ScriptValidator.script
- Command Package (autotransform.command)
- Command (autotransform.command.base)
- ScriptCommand (autotransform.command.script)
ScriptCommand
ScriptCommand.args
ScriptCommand.script
ScriptCommand.per_item
ScriptCommand.run_on_changes
ScriptCommand.run_pre_validation
ScriptCommand.name
ScriptCommand.args
ScriptCommand.name
ScriptCommand.per_item
ScriptCommand.run()
ScriptCommand.run_on_changes
ScriptCommand.run_pre_validation
ScriptCommand.script
- Repo Package (autotransform.repo)
- Repo (autotransform.repo.base)
- GitRepo (autotransform.repo.git)
GitRepo
GitRepo.base_branch
GitRepo.name
GitRepo.BRANCH_NAME_PREFIX
GitRepo.COMMIT_MESSAGE_PREFIX
GitRepo.BRANCH_NAME_PREFIX
GitRepo.COMMIT_MESSAGE_PREFIX
GitRepo.base_branch
GitRepo.clean()
GitRepo.commit()
GitRepo.get_branch_name()
GitRepo.get_changed_files()
GitRepo.get_changed_files_from_status()
GitRepo.get_commit_message()
GitRepo.get_outstanding_changes()
GitRepo.has_outstanding_change()
GitRepo.name
GitRepo.rewind()
GitRepo.submit()
- GithubRepo (autotransform.repo.github)
GithubRepo
GithubRepo.full_github_name
GithubRepo.commit_repo
GithubRepo.hide_automation_info
GithubRepo.hide_autotransform_docs
GithubRepo.labels
GithubRepo.reviewers
GithubRepo.team_reviewers
GithubRepo.name
GithubRepo.commit_repo
GithubRepo.full_github_name
GithubRepo.get_automation_info()
GithubRepo.get_outstanding_changes()
GithubRepo.has_outstanding_change()
GithubRepo.hide_automation_info
GithubRepo.hide_autotransform_docs
GithubRepo.labels
GithubRepo.name
GithubRepo.reviewers
GithubRepo.submit()
GithubRepo.team_reviewers
GithubRepoBatchMetadata