utils.py

• Changed:
  • format_requirement:
    • Add optional str kwarg from_dir:
      • If used, it'll rewrite local paths as relative (to from_dir).
    • Replace alternative path separators in relpaths with forward slashes.
    • Use pip's path_to_url for abs paths.
    • Ensure fragment is attached if present originally.
• Added:

  • Function abs_ireq:

    def abs_ireq(ireq: InstallRequirement, from_dir: str) -> InstallRequirement:
        """
        Return the given InstallRequirement if its source isn't a relative path;
        Otherwise, return a new one with the relative path rewritten as absolute.
    
        In this case, an extra attribute is added: _was_relative,
        which is always True when present at all.
        """

  • Context manager working_dir:

    @contextmanager
    def working_dir(folder: Optional[str]) -> Iterator[None]:
        """Change the current directory within the context, then change it back."""

  • Function fragment_string:

    def fragment_string(ireq: InstallRequirement) -> str:
        """
        Return a string like "#egg=pkgname&subdirectory=folder", or "".
        """

pip_compat.py

• Changed:
  • parse_requirements:
    • Add optional str kwarg from_dir to parse_requirements.
      If left to its default, None, the parent of the source file is used.
      Either way it's passed to abs_ireq, so any yielded local ireqs
      have absolute .links, and some have ._was_relative.
    • Ensure pip's install_req_from_parsed_requirement is called from a sensible folder,
      to better resolve relative paths; and try to detect if each ireq was initially relative,
      to "manually" mark the resulting (absolute) ireq with _was_relative.

compile.py

• Change Click argument type for the output file from File to Path.
  When Click's File object is initialized with the absolute path,
  that full path is preserved as the .name attribute. So we now instantiate
  the output File ourselves after resolving its absolute path.
• Resolve src_files to their absolute paths.
• When deriving the output path from a single input path,
  ensure it's properly adjacent to the input,
  and stay safer and more predictable when the basename has no dot and the path does,
  or the input file ends in .txt (see Choose an approach for coherent path handling #1067, pip-compile annotations should be relative to file they are in #1107, and tests below).
• Use abs_ireq when collecting upgrade_install_reqs (--upgrade-package),
  passing the invocation dir as from_dir.
• No support for relative paths is introduced for setup.py install_requires,
  given the discussion @ https://discuss.python.org/t/what-is-the-correct-interpretation-of-path-based-pep-508-uri-reference/2815/18
• Ensure a suitable from_dir is passed to parse_requirements
  when parsing from setup.py or stdin, which really parses a temp file.
  This means setup.py's parent folder, or the invocation dir if the source is stdin.

writer.py

• Added:
  • comes_from_line_project_re pattern for parsing and rewriting
    comes_from strs that point to setup.pys and pyproject.tomls.
• Changed:
  • strip_comes_from_line_re:
    • Extend/replace the pattern as comes_from_line_re,
      with named groups for opts (-r/-c), path, and line_num.
  • _comes_from_as_string:
    • Add optional str kwarg from_dir.
      If the ireq.comes_from is already a str and from_dir is passed,
      in addition to stripping the line number as before, rewrite the path as relative.
    • Add handling for comes_from_line_project_re matches.
  • _format_requirement:
    • If the ireq has ._was_relative and the output is a file,
      pass the output file's parent as from_dir to format_requirement,
      ensuring the written path for the ireq is relative in that case.
    • Pass the parent of the output file, if any, as from_dir to _comes_from_as_string.

test_cli_compile.py

• Added:
  • test_relative_local_package
    • Relative paths are properly resolved between input, output, and local packages.
    • Input file paths/URIs can be relative, as long as they start with file: or ..
  • test_input_file_with_txt_extension
    • Compile an input file ending in .txt to a separate output file (*.txt.txt),
      without overwriting the input file.
  • test_input_file_without_extension_and_dotted_path
    • Compile a file without an extension, in a subdir with a dot,
      into an input-adjacent file with .txt as the extension.
  • test_annotation_relative_paths
    • Annotations referencing reqs.in files use paths relative to the reqs.txt.
  • test_local_vcs_package
    • git+file urls are rewritten to use absolute paths, and otherwise remain intact.
• Changed:
  • test_duplicate_reqs_combined
    • Use pip's path_to_url to detect the normalized package path in URL form.

test_writer.py

• Changed:
  • writer fixture:
    • Open an output file object to pass to OutputWriter,
      rather than passing the click ctx entry (now just a Path).
  • test_write_header:
    • Access the user-supplied output file path via
      writer.click_ctx.params["output_file"] (now just a Path), rather than
      checking that for a .name.
  • test_iter_lines__hash_missing:
    • Use regex match to recognize Windows drive names.
  • test_iter_lines__no_warn_if_only_unhashable_packages:
    • Use regex match to recognize Windows drive names.
• Added:
  • test_format_requirement_annotation_source_ireqs

test_utils.py

• Changed:
  • test_format_requirement_editable_local_path
    • Use regex match to recognize Windows drive names.
• Added:
  • test_working_dir
  • test_local_abs_ireq_preserves_source_ireqs