Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Raise an exception when find_tex_file fails to find a file.#21356

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
QuLogic merged 1 commit intomatplotlib:masterfromanntzer:ftf
Oct 15, 2021

Conversation

anntzer
Copy link
Contributor

The exception message is clearer for end users than downstream callers
failing toopen() a file named"".

Also update the function's docstring.

_tfmfile now never returns None (an exception would have been raised
earlier by find_tex_file), so remove the corresponding branch.

From a quick look,#21354 seems to arise from a missingpdftex.map;
this patch would have made the error clearer.

PR Summary

PR Checklist

  • Has pytest style unit tests (andpytest passes).
  • IsFlake 8 compliant (runflake8 on changed files to check).
  • New features are documented, with examples if plot related.
  • Documentation is sphinx and numpydoc compliant (the docs shouldbuild without error).
  • Conforms to Matplotlib style conventions (installflake8-docstrings and runflake8 --docstring-convention=all).
  • New features have an entry indoc/users/next_whats_new/ (follow instructions in README.rst there).
  • API changes documented indoc/api/next_api_changes/ (follow instructions in README.rst there).

Copy link
Member

@timhoffmtimhoffm left a comment•
edited
Loading

Choose a reason for hiding this comment

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

I'm slightly worried on the API change. There might be users out there usingfind_tex_file to check if a package is installed.

The more defensive approach would be:

  • Iffind_tex_file doesn't find a file it issues a warning that it will fali in the future. But it still returns '' for now.
  • Tempoarily we add a function
    def _find_tex_file_or_raise(filename):    with.warnings.catch_warnings():        warnings.filter(...)        tex_file = find_tex_file(filename)        if not tex_file:           raise FileNotFoundError(...)        return tex_file
  • and replace all internal usages with this function.

This would give nice error messages for internal problems but still givesfind_tex_file users the opportunity to prepare for the API change.

@anntzer
Copy link
ContributorAuthor

OK, switch to warning.

The exception message is clearer for end users than downstream callersfailing to `open()` a file named `""`.Also update the function's docstring._tfmfile now never returns None (an exception would have been raisedearlier by find_tex_file), so remove the corresponding branch.
@QuLogicQuLogic merged commit3587a9f intomatplotlib:masterOct 15, 2021
@QuLogicQuLogic added this to thev3.6.0 milestoneOct 15, 2021
@anntzeranntzer deleted the ftf branchOctober 16, 2021 07:41
tacaswell pushed a commit that referenced this pull requestOct 20, 2021
Raise an exception when find_tex_file fails to find a file.
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@QuLogicQuLogicQuLogic approved these changes

@timhoffmtimhoffmtimhoffm approved these changes

Assignees
No one assigned
Projects
None yet
Milestone
v3.6.0
Development

Successfully merging this pull request may close these issues.

3 participants
@anntzer@QuLogic@timhoffm
[8]ページ先頭
©2009-2025 Movatter.jp