You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
o3de/scripts/o3de.py

113 lines
3.5 KiB
Python

#
# All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
# its licensors.
#
# For complete copyright and license terms please see the LICENSE at the root of this
# distribution (the "License"). All use of this software is governed by the License,
# or, if provided, by the license below or the license accompanying this file. Do not
# remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#
import argparse
import pathlib
import sys
def add_args(parser, subparsers) -> None:
"""
add_args is called to add expected parser arguments and subparsers arguments to each command such that it can be
invoked by o3de.py
Ex o3de.py can invoke the register downloadable commands by importing register,
call add_args and execute: python o3de.py register --gem-path "C:/TestGem"
:param parser: the caller instantiates a parser and passes it in here
:param subparsers: the caller instantiates subparsers and passes it in here
"""
# As o3de.py shares the same name as the o3de package attempting to use a regular
# from o3de import <module> line tries to import from the current o3de.py script and not the package
# So the current script directory is removed from the sys.path temporary
script_dir_removed = False
script_abs_dir_removed = False
script_dir = pathlib.Path(__file__).parent
script_abs_dir = pathlib.Path(__file__).parent.resolve()
while str(script_dir) in sys.path:
script_dir_removed = True
sys.path.remove(str(script_dir))
while str(script_abs_dir) in sys.path:
script_abs_dir_removed = True
# Remove the absolute path to the script_dir as well
sys.path.remove(str(script_abs_dir.resolve()))
from o3de import engine_template, global_project, register, print_registration, get_registration, download, \
add_external_subdirectory, remove_external_subdirectory, add_gem_cmake, remove_gem_cmake, add_gem_project, \
remove_gem_project, sha256
if script_abs_dir_removed:
sys.path.insert(0, str(script_abs_dir))
if script_dir_removed:
sys.path.insert(0, str(script_dir))
# global_project
global_project.add_args(subparsers)
# engine templaate
engine_template.add_args(subparsers)
# register
register.add_args(subparsers)
# show
print_registration.add_args(subparsers)
# get-registered
get_registration.add_args(subparsers)
# download
download.add_args(subparsers)
# add external subdirectories
add_external_subdirectory.add_args(subparsers)
# remove external subdirectories
remove_external_subdirectory.add_args(subparsers)
# add gems to cmake
add_gem_cmake.add_args(subparsers)
# remove gems from cmake
remove_gem_cmake.add_args(subparsers)
# add a gem to a project
add_gem_project.add_args(subparsers)
# remove a gem from a project
remove_gem_project.add_args(subparsers)
# sha256
sha256.add_args(subparsers)
if __name__ == "__main__":
# parse the command line args
the_parser = argparse.ArgumentParser()
# add subparsers
the_subparsers = the_parser.add_subparsers(help='sub-command help')
# add args to the parser
add_args(the_parser, the_subparsers)
# parse args
the_args = the_parser.parse_args()
# if empty print help
if len(sys.argv) == 1:
the_parser.print_help(sys.stderr)
sys.exit(1)
# run
ret = the_args.func(the_args)
# return
sys.exit(ret)