Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

consolidate port loading code + embuilder documentation #21353

Merged
merged 4 commits into from
Feb 16, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions ChangeLog.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,9 @@ See docs/process.md for more on how version tagging works.
#21276)
- Added concept of external ports which live outside emscripten and are
loaded on demand using the syntax `--use-port=/path/to/my_port.py` (#21316)
- `embuilder` can now build ports with options as well as external ports using
the same syntax introduced with `--use-port`
(ex: `embuilder sdl2_image:formats=png,jpg`) (#21345)
- Allow comments in response files. Any line starting with `#` is now ignored.
This is useful when listing exported symbols. (#21330)

Expand Down
9 changes: 6 additions & 3 deletions docs/emcc.txt
Original file line number Diff line number Diff line change
Expand Up @@ -471,9 +471,12 @@ Options that are modified or new in *emcc* are listed below:

"--use-port=<port>"
[compile+link] Use the specified port. If you need to use more than
one port you can use this argument multiple times. For example: "--
use-port=sdl2 --use-port=bzip2". To get the list of available
ports, use "--show-ports".
one port you can use this option multiple times (ex: "--use-
port=sdl2 --use-port=bzip2"). A port can have options separated by
":" (ex: "--use-port=sdl2_image:formats=png,jpg"). To use an
external port, you provide the path to the port directly (ex: "--
use-port=/path/to/my_port.py"). To get the list of available ports,
use "--show-ports".

"--clear-ports"
[general] Manually clears the local copies of ports from the
Expand Down
10 changes: 7 additions & 3 deletions site/source/docs/tools_reference/emcc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -461,9 +461,13 @@ Options that are modified or new in *emcc* are listed below:

``--use-port=<port>``
[compile+link]
Use the specified port. If you need to use more than one port you can use this
argument multiple times. For example: ``--use-port=sdl2 --use-port=bzip2``.
To get the list of available ports, use ``--show-ports``.
Use the specified port. If you need to use more than one port you can use
this option multiple times (ex: ``--use-port=sdl2 --use-port=bzip2``). A port
can have options separated by ``:``
(ex: ``--use-port=sdl2_image:formats=png,jpg``). To use an external port,
you provide the path to the port directly
(ex: ``--use-port=/path/to/my_port.py``). To get the list of available ports,
use ``--show-ports``.

.. _emcc-clear-ports:

Expand Down
19 changes: 7 additions & 12 deletions tools/ports/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -67,13 +67,9 @@ def init_port(name, port):
validate_port(port)


def load_port_by_name(name):
port = __import__(name, globals(), level=1, fromlist=[None])
init_port(name, port)


def load_port_by_path(path):
name = os.path.splitext(os.path.basename(path))[0]
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unrelated to this change, but I'm a little curious about the sys.modules[module_name] = port line below. Is that necessary? What happens if you remove it?

def load_port(path, name=None):
if not name:
name = os.path.splitext(os.path.basename(path))[0]
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can use shared.unsuffixed_basename

if name in ports_by_name:
utils.exit_with_error(f'port path [`{path}`] is invalid: duplicate port name `{name}`')
module_name = f'tools.ports.{name}'
Expand All @@ -100,15 +96,14 @@ def read_ports():
for filename in os.listdir(ports_dir):
if not filename.endswith('.py') or filename == '__init__.py':
continue
filename = os.path.splitext(filename)[0]
load_port_by_name(filename)
load_port(os.path.join(ports_dir, filename))

contrib_dir = os.path.join(ports_dir, 'contrib')
for filename in os.listdir(contrib_dir):
if not filename.endswith('.py') or filename == '__init__.py':
continue
filename = os.path.splitext(filename)[0]
load_port_by_name('contrib.' + filename)
name = 'contrib.' + os.path.splitext(filename)[0]
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe use unsuffixed_basename here too?

load_port(os.path.join(contrib_dir, filename), name)


def get_all_files_under(dirname):
Expand Down Expand Up @@ -426,7 +421,7 @@ def error_handler(message):
port_file_path = name
if not os.path.isfile(port_file_path):
error_handler(f'not a valid port path: {port_file_path}')
name = load_port_by_path(port_file_path)
name = load_port(port_file_path)
elif name not in ports_by_name:
error_handler(f'invalid port name: `{name}`')
ports_needed.add(name)
Expand Down
Loading