async def resolve_pex_entry_point(request: ResolvePexEntryPointRequest) -> ResolvedPexEntryPoint:
ep_val = request.entry_point_field.value
if ep_val is None:
return ResolvedPexEntryPoint(None, file_name_used=False)
address = request.entry_point_field.address
# We support several different schemes:
# 1) `path.to.module` => preserve exactly.
# 2) `path.to.module:func` => preserve exactly.
# 3) `app.py` => convert into `path.to.app`.
# 4) `app.py:func` => convert into `path.to.app:func`.
# If it's already a module (cases #1 and #2), simply use that. Otherwise, convert the file name
# into a module path (cases #3 and #4).
if not ep_val.module.endswith(".py"):
return ResolvedPexEntryPoint(ep_val, file_name_used=False)
# Use the engine to validate that the file exists and that it resolves to only one file.
full_glob = os.path.join(address.spec_path, ep_val.module)
entry_point_paths = await Get(
Paths,
PathGlobs(
[full_glob],
glob_match_error_behavior=GlobMatchErrorBehavior.error,
description_of_origin=f"{address}'s `{request.entry_point_field.alias}` field",
),
)
# We will have already raised if the glob did not match, i.e. if there were no files. But
# we need to check if they used a file glob (`*` or `**`) that resolved to >1 file.
if len(entry_point_paths.files) != 1:
raise InvalidFieldException(
softwrap(
f"""
Multiple files matched for the `{request.entry_point_field.alias}`
{ep_val.spec!r} for the target {address}, but only one file expected. Are you using
a glob, rather than a file name?
All matching files: {list(entry_point_paths.files)}.
"""
)
)
entry_point_path = entry_point_paths.files[0]
source_root = await Get(
SourceRoot,
SourceRootRequest,
SourceRootRequest.for_file(entry_point_path),
)
stripped_source_path = os.path.relpath(entry_point_path, source_root.path)
module_base, _ = os.path.splitext(stripped_source_path)
normalized_path = module_base.replace(os.path.sep, ".")
return ResolvedPexEntryPoint(
dataclasses.replace(ep_val, module=normalized_path), file_name_used=True
)
async def resolve_pex_entry_point(
request: ResolvePexEntryPointRequest) -> ResolvedPexEntryPoint:
ep_val = request.entry_point_field.value
ep_alias = request.entry_point_field.alias
address = request.entry_point_field.address
# TODO: factor up some of this code between python_awslambda and pex_binary once `sources` is
# removed.
# This code is tricky, as we support several different schemes:
# 1) `<none>` or `<None>` => set to `None`.
# 2) `path.to.module` => preserve exactly.
# 3) `path.to.module:func` => preserve exactly.
# 4) `app.py` => convert into `path.to.app`.
# 5) `app.py:func` => convert into `path.to.app:func`.
if ep_val is None:
instructions_url = docs_url(
"python-package-goal#creating-a-pex-file-from-a-pex_binary-target")
raise InvalidFieldException(
f"The `{ep_alias}` field is not set for the target {address}. Run "
f"`./pants help pex_binary` for more information on how to set the field or "
f"see {instructions_url}.")
# Case #1.
if ep_val.module in ("<none>", "<None>"):
return ResolvedPexEntryPoint(None)
# If it's already a module (cases #2 and #3), simply use that. Otherwise, convert the file name
# into a module path (cases #4 and #5).
if not ep_val.module.endswith(".py"):
return ResolvedPexEntryPoint(ep_val)
# Use the engine to validate that the file exists and that it resolves to only one file.
full_glob = os.path.join(address.spec_path, ep_val.module)
entry_point_paths = await Get(
Paths,
PathGlobs(
[full_glob],
glob_match_error_behavior=GlobMatchErrorBehavior.error,
description_of_origin=
f"{address}'s `{request.entry_point_field.alias}` field",
),
)
# We will have already raised if the glob did not match, i.e. if there were no files. But
# we need to check if they used a file glob (`*` or `**`) that resolved to >1 file.
if len(entry_point_paths.files) != 1:
raise InvalidFieldException(
f"Multiple files matched for the `{ep_alias}` {ep_val.spec!r} for the target "
f"{address}, but only one file expected. Are you using a glob, rather than a file "
f"name?\n\nAll matching files: {list(entry_point_paths.files)}.")
entry_point_path = entry_point_paths.files[0]
source_root = await Get(
SourceRoot,
SourceRootRequest,
SourceRootRequest.for_file(entry_point_path),
)
stripped_source_path = os.path.relpath(entry_point_path, source_root.path)
module_base, _ = os.path.splitext(stripped_source_path)
normalized_path = module_base.replace(os.path.sep, ".")
return ResolvedPexEntryPoint(
dataclasses.replace(ep_val, module=normalized_path))
async def resolve_pex_entry_point(
request: ResolvePexEntryPointRequest) -> ResolvedPexEntryPoint:
ep_val = request.entry_point_field.value
ep_alias = request.entry_point_field.alias
address = request.entry_point_field.address
# TODO: factor up some of this code between python_awslambda and pex_binary once `sources` is
# removed.
# This code is tricky, as we support several different schemes:
# 1) `<none>` or `<None>` => set to `None`.
# 2) `path.to.module` => preserve exactly.
# 3) `path.to.module:func` => preserve exactly.
# 4) `app.py` => convert into `path.to.app`.
# 5) `app.py:func` => convert into `path.to.app:func`.
# 6) `:func` => if there's a sources field, convert to `path.to.sources:func` (deprecated).
# 7) no entry point field, but `sources` field => convert to `path.to.sources` (deprecated).
# Handle deprecated cases #6 and #7, which are the only cases where the `sources` field matters
# for calculating the entry point.
if not ep_val or ep_val.startswith(":"):
binary_source_paths = await Get(
Paths, PathGlobs,
request.sources.path_globs(FilesNotFoundBehavior.error))
if len(binary_source_paths.files) != 1:
instructions_url = docs_url(
"python-package-goal#creating-a-pex-file-from-a-pex_binary-target"
)
if not ep_val:
raise InvalidFieldException(
f"The `{ep_alias}` field is not set for the target {address}. Run "
f"`./pants help pex_binary` for more information on how to set the field or "
f"see {instructions_url}.")
raise InvalidFieldException(
f"The `{ep_alias}` field for the target {address} is set to the short-hand value "
f"{repr(ep_val)}, but the `sources` field is not set. Pants requires the "
"`sources` field to expand the entry point to the normalized form "
f"`path.to.module:{ep_val}`. Please either set the `sources` field to exactly one "
f"file (deprecated) or set `{ep_alias}='my_file.py:{ep_val}'`. See "
f"{instructions_url}.")
entry_point_path = binary_source_paths.files[0]
source_root = await Get(
SourceRoot,
SourceRootRequest,
SourceRootRequest.for_file(entry_point_path),
)
stripped_source_path = os.path.relpath(entry_point_path,
source_root.path)
module_base, _ = os.path.splitext(stripped_source_path)
normalized_path = module_base.replace(os.path.sep, ".")
return ResolvedPexEntryPoint(
f"{normalized_path}{ep_val}" if ep_val else normalized_path)
# Case #1.
if ep_val in ("<none>", "<None>"):
return ResolvedPexEntryPoint(None)
path, _, func = ep_val.partition(":")
# If it's already a module (cases #2 and #3), simply use that. Otherwise, convert the file name
# into a module path (cases #4 and #5).
if not path.endswith(".py"):
return ResolvedPexEntryPoint(ep_val)
# Use the engine to validate that the file exists and that it resolves to only one file.
full_glob = os.path.join(address.spec_path, path)
entry_point_paths = await Get(
Paths,
PathGlobs(
[full_glob],
glob_match_error_behavior=GlobMatchErrorBehavior.error,
description_of_origin=
f"{address}'s `{request.entry_point_field.alias}` field",
),
)
# We will have already raised if the glob did not match, i.e. if there were no files. But
# we need to check if they used a file glob (`*` or `**`) that resolved to >1 file.
if len(entry_point_paths.files) != 1:
raise InvalidFieldException(
f"Multiple files matched for the `{ep_alias}` {repr(ep_val)} for the target "
f"{address}, but only one file expected. Are you using a glob, rather than a file "
f"name?\n\nAll matching files: {list(entry_point_paths.files)}.")
entry_point_path = entry_point_paths.files[0]
source_root = await Get(
SourceRoot,
SourceRootRequest,
SourceRootRequest.for_file(entry_point_path),
)
stripped_source_path = os.path.relpath(entry_point_path, source_root.path)
module_base, _ = os.path.splitext(stripped_source_path)
normalized_path = module_base.replace(os.path.sep, ".")
return ResolvedPexEntryPoint(
f"{normalized_path}:{func}" if func else normalized_path)