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

[new check] special characters in filepaths #77

Open
2 tasks done
jameslamb opened this issue Oct 24, 2022 · 0 comments
Open
2 tasks done

[new check] special characters in filepaths #77

jameslamb opened this issue Oct 24, 2022 · 0 comments
Labels
enhancement New feature or request

Comments

@jameslamb
Copy link
Owner

jameslamb commented Oct 24, 2022

What should be checked?

pydistcheck should warn about the presence of filepaths with characters that can cause portability issues unrelated to encoding (#76 tracks a separate check on non-ASCII characters).

These include:

  • < (less than)
  • > (greater than)
  • : (colon)
  • " (double quote)
  • / (forward slash)
  • \ (backslash)
  • | (vertical bar or pipe)
  • ? (question mark)
  • * (asterisk)

(from "reserved characters" in the Windows filesystem docs).

They also include "control characters":

Filepaths only consisting of directory traversal characters should also result in a warning.

  • /
  • .
  • ..
  • \

Filepaths ending in the following should also result in warnings.

  • .
  • /
  • \
  • spaces (although other rules above should already prevent spaces)

What should the name of this check be?

special-characters-in-filepaths

Will this check introduce any additional configuration?

no

Details on additional configuration required.

No response

Distribution type

  • source (e.g. .tar.gz)
  • built (e.g. .whl)

Notes

@jameslamb jameslamb added the enhancement New feature or request label Oct 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant