Define error #2444

cjfghk5697 · 2024-08-13T13:26:11Z

#2069

I have implemented the suggestion from issue #2069. The FileMetadataError class has been moved from huggingface_hub/inference/_templating.py to huggingface_hub/errors.py.

Could you please review this PR? If this is correct, I will move the other classes in the same way.

cjfghk5697 · 2024-08-13T14:35:01Z

@Wauplin Are there any other error classes that need to be modified or moved besides FileMetadataError? Also, do you think there's a need for any error handling code for 500-level errors?

010kim · 2024-08-13T14:38:43Z

Hello, I was going over the same code actually. It looks like FileMetadataError is the only error that is not affected by hf_raise_for_status, so all the other errors _errors.py should remain there. @Wauplin So I won't create any separate PR. Thanks a lot for your response!

Wauplin

Hi @cjfghk5697 , thanks for your PR! Actually all errors from src/huggingface_hub/utils/_errors.py are entitled to move to src/huggingface_hub/errors.py as mentioned in #2069 (comment). The logic for hf_raise_for_status stays where it is but the error classes definitions have to move. It can be done in this PR or a separate one.

Also, do you think there's a need for any error handling code for 500-level errors?

I don't think there is a special need for that no. Those are usually caught as HfHttpError and then filtered using the status code directly.

src/huggingface_hub/file_download.py

Wauplin · 2024-08-13T16:26:54Z

Hello, I was going over the same code actually. It looks like FileMetadataError is the only error that is not affected by hf_raise_for_status, so all the other errors _errors.py should remain there. @Wauplin So I won't create any separate PR. Thanks a lot for your response!

@010kim sorry for the duplicate work. To avoid such a situation, would you like to focus on moving the 2 exceptions from src/huggingface_hub/utils/_cache_manager.py for example? They also have to be moved in a separate PR similar to this one.

010kim · 2024-08-13T23:00:10Z

Hello, I was going over the same code actually. It looks like FileMetadataError is the only error that is not affected by hf_raise_for_status, so all the other errors _errors.py should remain there. @Wauplin So I won't create any separate PR. Thanks a lot for your response!

@010kim sorry for the duplicate work. To avoid such a situation, would you like to focus on moving the 2 exceptions from src/huggingface_hub/utils/_cache_manager.py for example? They also have to be moved in a separate PR similar to this one.

Of course! That's great, I'm on it!

Co-authored-by: Lucain <[email protected]>

cjfghk5697 · 2024-08-16T14:23:27Z

@Wauplin, thank you for your reply! Do you have any recommended suggestions or issues for improving Hub?

Wauplin · 2024-08-16T14:54:07Z

Hi @cjfghk5697, thanks for asking! Sorry for the noise on your PR, let's refocus on this one first 😉 As mentioned in #2444 (review), it would be great to move all errors from src/huggingface_hub/utils/_errors.py to src/huggingface_hub/errors.py, not only FileMetadataError. The hf_raise_for_status should stay where it is. Could you have a look at that? 🙏 🤗

cjfghk5697 · 2024-08-16T15:02:08Z

@Wauplin Thank you! I'm a bit confused should the class used in hf_raise_for_status also be moved to error.py? For example, the RevisionNotFoundError class is used in hf_raise_for_status, but should it also be moved to error.py?🤗

Wauplin · 2024-08-16T15:27:06Z

I'm a bit confused should the class used in hf_raise_for_status also be moved to error.py? For example, the RevisionNotFoundError class is used in hf_raise_for_status, but should it also be moved to error.py?🤗

Yes, all of those classes! (RevisionNotFoundError, GatedRepoError, etc.)
Then, you'll have to import them back from src/huggingface_hub/errors.py in src/huggingface_hub/utils/_errors.py. The goal is to have all classes defined in the same errors module but we should still keep some logic outside (where it is currently)

cjfghk5697 · 2024-08-18T08:21:08Z

I'm a bit confused should the class used in hf_raise_for_status also be moved to error.py? For example, the RevisionNotFoundError class is used in hf_raise_for_status, but should it also be moved to error.py?🤗

Yes, all of those classes! (RevisionNotFoundError, GatedRepoError, etc.) Then, you'll have to import them back from src/huggingface_hub/errors.py in src/huggingface_hub/utils/_errors.py. The goal is to have all classes defined in the same errors module but we should still keep some logic outside (where it is currently)

I got it and appreciate your reply😊 The classes in _errors.py have been moved to errors.py. Could you check the file? 🤗.

Wauplin

Thanks @cjfghk5697 for the changes! Almost everything looks good to me for a merge. Left a minor comment and then we should be good to go! 🚀

Wauplin · 2024-08-19T14:12:19Z

src/huggingface_hub/utils/_errors.py

-REPO_API_REGEX = re.compile(
-    r"""
-        # staging or production endpoint
-        ^https://[^/]+
-        (
-            # on /api/repo_type/repo_id
-            /api/(models|datasets|spaces)/(.+)
-            |
-            # or /repo_id/resolve/revision/...
-            /(.+)/resolve/(.+)
-        )
-    """,
-    flags=re.VERBOSE,


This can be kept in ./utils/_errors.py since it's not a Exception class definition

cjfghk5697 · 2024-08-20T07:56:02Z

Thanks @Wauplin! I have put it back!

Wauplin

Perfect!

I fixed a circular import in f3525e6. That's why I want to avoid as much as possible logic to be defined in errors.py. Here we can't do without it so it's fine :)

HuggingFaceDocBuilderDev · 2024-08-20T08:39:07Z

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

Wauplin · 2024-08-20T08:42:01Z

Failing tests are unrelated to this PR so let's merge it :) Thanks @cjfghk5697 for the work and iterations 🤗

cjfghk5697 · 2024-08-22T12:53:19Z

@Wauplin
Is there anything else I can assist you with besides handling this issue? I'd be happy to offer additional support alongside the HuggingFace OSSCA team!

Wauplin · 2024-08-27T10:03:21Z

Hi @cjfghk5697, thanks again for your support! What do you say about tackling #2466? :) If not, you can always have a look to the list in https://github.com/huggingface/huggingface_hub/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22. Let me know if you have any preferences.

cjfghk5697 · 2024-08-29T12:49:47Z

Hi @Wauplin, thanks for the suggestion! I’ll go ahead and tackle #2466. Looking forward to working on it!

move FileMetadataError

0dbeb1e

cjfghk5697 closed this Aug 13, 2024

cjfghk5697 reopened this Aug 13, 2024

Merge branch 'main' into define_errors

8bdfab2

Wauplin reviewed Aug 13, 2024

View reviewed changes

src/huggingface_hub/file_download.py Outdated Show resolved Hide resolved

Apply suggestions from code review

f0a0ee5

Co-authored-by: Lucain <[email protected]>

cjfghk5697 added 3 commits August 18, 2024 17:10

Merge branch 'main' into define_errors

99f5c66

Defien Errors

3f2f2a2

defines error

1dd1a5f

Wauplin reviewed Aug 19, 2024

View reviewed changes

keep REPO_API_REGEX

d298e4f

Wauplin approved these changes Aug 20, 2024

View reviewed changes

fix circular import

f3525e6

Wauplin merged commit 509a431 into huggingface:main Aug 20, 2024
14 of 18 checks passed

cjfghk5697 deleted the define_errors branch August 20, 2024 12:36

Wauplin mentioned this pull request Aug 27, 2024

Define all errors in ./src/huggingface_hub/errors.py #2069

Closed

Wauplin mentioned this pull request Aug 29, 2024

Add support for /auth-check #2466

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Define error #2444

Define error #2444

cjfghk5697 commented Aug 13, 2024

cjfghk5697 commented Aug 13, 2024

010kim commented Aug 13, 2024

Wauplin left a comment

Wauplin commented Aug 13, 2024

010kim commented Aug 13, 2024

cjfghk5697 commented Aug 16, 2024

Wauplin commented Aug 16, 2024

cjfghk5697 commented Aug 16, 2024 •

edited

Loading

Wauplin commented Aug 16, 2024

cjfghk5697 commented Aug 18, 2024 •

edited

Loading

Wauplin left a comment

Wauplin Aug 19, 2024

cjfghk5697 commented Aug 20, 2024

Wauplin left a comment •

edited

Loading

HuggingFaceDocBuilderDev commented Aug 20, 2024

Wauplin commented Aug 20, 2024 •

edited

Loading

cjfghk5697 commented Aug 22, 2024 •

edited

Loading

Wauplin commented Aug 27, 2024 •

edited

Loading

cjfghk5697 commented Aug 29, 2024

Define error #2444

Define error #2444

Conversation

cjfghk5697 commented Aug 13, 2024

cjfghk5697 commented Aug 13, 2024

010kim commented Aug 13, 2024

Wauplin left a comment

Choose a reason for hiding this comment

Wauplin commented Aug 13, 2024

010kim commented Aug 13, 2024

cjfghk5697 commented Aug 16, 2024

Wauplin commented Aug 16, 2024

cjfghk5697 commented Aug 16, 2024 • edited Loading

Wauplin commented Aug 16, 2024

cjfghk5697 commented Aug 18, 2024 • edited Loading

Wauplin left a comment

Choose a reason for hiding this comment

Wauplin Aug 19, 2024

Choose a reason for hiding this comment

cjfghk5697 commented Aug 20, 2024

Wauplin left a comment • edited Loading

Choose a reason for hiding this comment

HuggingFaceDocBuilderDev commented Aug 20, 2024

Wauplin commented Aug 20, 2024 • edited Loading

cjfghk5697 commented Aug 22, 2024 • edited Loading

Wauplin commented Aug 27, 2024 • edited Loading

cjfghk5697 commented Aug 29, 2024

cjfghk5697 commented Aug 16, 2024 •

edited

Loading

cjfghk5697 commented Aug 18, 2024 •

edited

Loading

Wauplin left a comment •

edited

Loading

Wauplin commented Aug 20, 2024 •

edited

Loading

cjfghk5697 commented Aug 22, 2024 •

edited

Loading

Wauplin commented Aug 27, 2024 •

edited

Loading