Add Collect creator data from Europeana API #5057

dryruffian · 2024-10-20T13:04:35Z

Fixes

Description

Added a New method _get_creator in class EuropeanaRecordBuilder to collect cerator data form dcCreator field, which contains the creator information, is now extracted and included in the record data.

Checklist

My pull request has a descriptive title (not a vague title likeUpdate index.md).
My pull request targets the default branch of the repository (main) or a parent feature branch.
My commit messages follow best practices.
My code follows the established code style of the repository.
I added or updated tests for the changes I made (if applicable).
I added or updated documentation (if applicable).
I tried running the project locally and verified that there are no visible errors.
I ran the DAG documentation generator (ov just catalog/generate-docs for catalog
PRs) or the media properties generator (ov just catalog/generate-docs media-props
for the catalog or ov just api/generate-docs for the API) where applicable.

Developer Certificate of Origin

Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

dryruffian · 2024-10-21T10:30:27Z

Yo @obulat, can you please review this PR? It adds a new method to the EuropeanaRecordBuilder class that collects creator data from the dcCreator field.

obulat

This PR is almost there, @dryruffian! There are two points that need to be fixed to make it working correctly.

obulat · 2024-10-21T15:44:46Z

catalog/dags/providers/provider_api_scripts/europeana.py

@@ -68,6 +68,7 @@ def get_record_data(self, data: dict) -> dict | None:
                "foreign_identifier": self._get_foreign_identifier(data),
                "meta_data": self._get_meta_data_dict(data),
                "title": self._get_title(data),
+                "creator": self._get_creator(item_data),


Suggested change

"creator": self._get_creator(item_data),

"creator": self._get_creator(data),

I tested this PR using October 1st as the date. The dcCreator is available in data dictionary, not item_data.

obulat · 2024-10-21T15:46:46Z

catalog/dags/providers/provider_api_scripts/europeana.py

+        creators = item_data.get("dcCreator", [])
+        if not creators:
+            return None
+        return creators if isinstance(creators, str) else ", ".join(creators)


I think it's better to check if the creators is an instance of list or not:

if isinstance(creators, list): return ", ".join(creators) elif isinstance(creators, str): return creators return None

thank's @obulat for the suggestion I have updated the code to check creators is an instance of list or not. I have also added also tests for some edge cases

obulat · 2024-10-21T15:48:41Z

catalog/tests/dags/providers/provider_api_scripts/test_europeana.py

+    "item_data, expected",
+    [
+        # Single creator in a list
+        pytest.param({"dcCreator": ["Chandler"]}, "Chandler", id="single_creator"),


dryruffian · 2024-10-22T15:31:30Z

Hi, @obulat can you assist me with the codespell issue

krysal

Jumping in to leave some observations!

krysal · 2024-10-22T17:32:04Z

catalog/tests/dags/providers/provider_api_scripts/test_europeana.py

+    expected_creator = (
+        "http://hispana.mcu.es/lod/oai:bibliotecadigital.jcyl.es:26229#ent2, "


You might need to fix these strings before fixing the grammar.

Suggested change

expected_creator = (

"http://hispana.mcu.es/lod/oai:bibliotecadigital.jcyl.es:26229#ent2, "

expected_creator = (

"http://hispana.mcu.es/lod/oai:bibliotecadigital.jcyl.es:26229#ent2, "

But also, given the signature of the new _get_creator method, it should return a string, not a set.

catalog/dags/providers/provider_api_scripts/europeana.py

openverse-bot · 2024-10-25T00:00:07Z

Based on the contributor urgency of this PR, the following reviewers are being gently reminded to review this PR:

@obulat
This reminder is being automatically generated due to the urgency configuration.

Excluding weekend¹ days, this PR was ready for review 4 day(s) ago. PRs labelled with contributor urgency are expected to be reviewed within 3 weekday(s)².

@dryruffian, if this PR is not ready for a review, please draft it to prevent reviewers from getting further unnecessary pings.

Specifically, Saturday and Sunday. ↩
For the purpose of these reminders we treat Monday - Friday as weekdays. Please note that the operation that generates these reminders runs at midnight UTC on Monday - Friday. This means that depending on your timezone, you may be pinged outside of the expected range. ↩

dryruffian · 2024-10-26T15:58:38Z

Hi @krysal,
I've made the suggested changes to the code. Would you be able to review it now?

obulat

This is almost there! Just 2 tiny changes needed

obulat · 2024-10-27T14:31:27Z

catalog/dags/providers/provider_api_scripts/europeana.py

@@ -163,7 +163,7 @@ def _get_creator(self, data: dict) -> str | None:
        if isinstance(creators, list):
            if not creators:  # Explicitly handle empty list


It would be better to move the if not creators condition higher, so we return None both for an empty list and an empty string ("").

catalog/dags/providers/provider_api_scripts/europeana.py

catalog/tests/dags/providers/provider_api_scripts/test_europeana.py

.codespell/ignore_lines.txt

catalog/tests/dags/providers/provider_api_scripts/test_europeana.py

obulat · 2024-10-28T18:59:58Z

.codespell/ignore_lines.txt

@@ -19,4 +19,4 @@

 ;; packages/js/eslint-plugin/configs/vue.ts
 ;; `te` gets matched with `the` and others
-const i18nDestructureRules = ["t", "tc", "te", "td", "d", "n"].map(
+const i18nDestructureRules = ["t", "tc", "te", "td", "d", "n"].map(


Suggested change

const i18nDestructureRules = ["t", "tc", "te", "td", "d", "n"].map(

const i18nDestructureRules = ["t", "tc", "te", "td", "d", "n"].map(

catalog/tests/dags/providers/provider_api_scripts/test_europeana.py

)

Co-authored-by: Krystle Salazar <[email protected]>

)

…na.py

obulat

I added the last bit of change requests to this PR, and now the CI is passing.

Thank you for your contribution, @dryruffian! Europeana has very high-quality media, and now Openverse will have better data for these media items, and they will be easier to find ✨

* Add Collect creator data from Europeana API (Fixes WordPress#2834) * Add Collect creator method data from Europeana API (Fixes WordPress#2834) Co-authored-by: Krystle Salazar <[email protected]> Co-authored-by: Olga Bulat <[email protected]>

dryruffian requested a review from a team as a code owner October 20, 2024 13:04

dryruffian requested review from obulat and stacimc and removed request for a team October 20, 2024 13:04

openverse-bot added 🧱 stack: catalog Related to the catalog and Airflow DAGs 🟨 priority: medium Not blocking but should be addressed soon ✨ goal: improvement Improvement to an existing user-facing feature 💻 aspect: code Concerns the software code in the repository labels Oct 20, 2024

obulat requested changes Oct 21, 2024

View reviewed changes

obulat removed the request for review from stacimc October 21, 2024 15:49

dryruffian requested a review from a team as a code owner October 21, 2024 17:36

dryruffian requested review from obulat and stacimc and removed request for a team October 21, 2024 17:36

krysal reviewed Oct 22, 2024

View reviewed changes

krysal removed the request for review from stacimc October 22, 2024 17:33

krysal marked this pull request as draft October 25, 2024 22:01

dryruffian marked this pull request as ready for review October 26, 2024 15:59

obulat requested changes Oct 27, 2024

View reviewed changes

obulat reviewed Oct 28, 2024

View reviewed changes

catalog/tests/dags/providers/provider_api_scripts/test_europeana.py Outdated Show resolved Hide resolved

obulat reviewed Oct 28, 2024

View reviewed changes

.codespell/ignore_lines.txt Outdated Show resolved Hide resolved

obulat reviewed Oct 28, 2024

View reviewed changes

catalog/tests/dags/providers/provider_api_scripts/test_europeana.py Outdated Show resolved Hide resolved

obulat reviewed Oct 28, 2024

View reviewed changes

obulat reviewed Oct 29, 2024

View reviewed changes

catalog/tests/dags/providers/provider_api_scripts/test_europeana.py Outdated Show resolved Hide resolved

dryruffian added 2 commits October 29, 2024 08:09

Add Collect creator data from Europeana API (Fixes WordPress#2834)

7d896b1

Add Collect creator method data from Europeana API (Fixes WordPress#2834

1e21e05

)

dryruffian and others added 16 commits October 29, 2024 08:09

Add Collect creator method data from Europeana API (Fixes WordPress#2834

351ab19

)

Add Collect creator method data from Europeana API (Fixes WordPress#2834

54487a1

)

Add Collect creator method data from Europeana API (Fixes WordPress#2834

3753a45

)

Add Collect creator method data from Europeana API (Fixes WordPress#2834

d6e103f

)

Add Collect creator data from Europeana API

4238d24

Co-authored-by: Krystle Salazar <[email protected]>

Add Collect creator method data from Europeana API (Fixes WordPress#2834

18fdd6b

)

Add Collect creator method data from Europeana API (Fixes WordPress#2834

d430453

)

Ignore the line

c78ff63

Update .codespell/ignore_lines.txt

332d3a5

Update catalog/dags/providers/provider_api_scripts/europeana.py

0f80c1a

Update catalog/tests/dags/providers/provider_api_scripts/test_europea…

4fd8743

…na.py

Fix ignore_lines.txt

7c29968

Handle empty string and list

8586ddf

Update tests

82444b5

Filter out empty strings

75bd1c1

Update catalog/tests/dags/providers/provider_api_scripts/test_europea…

643cead

…na.py

obulat force-pushed the main branch from 9cb342c to 643cead Compare October 29, 2024 05:09

obulat approved these changes Oct 29, 2024

View reviewed changes

obulat merged commit c4fa959 into WordPress:main Oct 29, 2024
46 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Collect creator data from Europeana API #5057

Add Collect creator data from Europeana API #5057

dryruffian commented Oct 20, 2024 •

edited

Loading

dryruffian commented Oct 21, 2024

obulat left a comment

obulat Oct 21, 2024

obulat Oct 21, 2024

dryruffian Oct 21, 2024

obulat Oct 21, 2024

dryruffian commented Oct 22, 2024

krysal left a comment

krysal Oct 22, 2024

openverse-bot commented Oct 25, 2024

dryruffian commented Oct 26, 2024 •

edited

Loading

obulat left a comment

obulat Oct 27, 2024

obulat Oct 28, 2024

obulat left a comment

	"creator": self._get_creator(item_data),
	"creator": self._get_creator(data),

		expected_creator = (
		"http://hispana.mcu.es/lod/oai:bibliotecadigital.jcyl.es:26229#ent2, "

		@@ -163,7 +163,7 @@ def _get_creator(self, data: dict) -> str \| None:
		if isinstance(creators, list):
		if not creators: # Explicitly handle empty list

	const i18nDestructureRules = ["t", "tc", "te", "td", "d", "n"].map(
	const i18nDestructureRules = ["t", "tc", "te", "td", "d", "n"].map(

Add Collect creator data from Europeana API #5057

Add Collect creator data from Europeana API #5057

Conversation

dryruffian commented Oct 20, 2024 • edited Loading

Fixes

Description

Checklist

Developer Certificate of Origin

dryruffian commented Oct 21, 2024

obulat left a comment

Choose a reason for hiding this comment

obulat Oct 21, 2024

Choose a reason for hiding this comment

obulat Oct 21, 2024

Choose a reason for hiding this comment

dryruffian Oct 21, 2024

Choose a reason for hiding this comment

obulat Oct 21, 2024

Choose a reason for hiding this comment

dryruffian commented Oct 22, 2024

krysal left a comment

Choose a reason for hiding this comment

krysal Oct 22, 2024

Choose a reason for hiding this comment

openverse-bot commented Oct 25, 2024

Footnotes

dryruffian commented Oct 26, 2024 • edited Loading

obulat left a comment

Choose a reason for hiding this comment

obulat Oct 27, 2024

Choose a reason for hiding this comment

obulat Oct 28, 2024

Choose a reason for hiding this comment

obulat left a comment

Choose a reason for hiding this comment

dryruffian commented Oct 20, 2024 •

edited

Loading

dryruffian commented Oct 26, 2024 •

edited

Loading