meta_oxide 0.1.1

Universal metadata extraction library supporting 13 formats (HTML Meta, Open Graph, Twitter Cards, JSON-LD, Microdata, Microformats, RDFa, Dublin Core, Web App Manifest, oEmbed, rel-links, Images, SEO) with 7 language bindings
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
"""
Tests for JSON-LD Recipe type support (Schema.org Recipe)

This module tests the extraction of Recipe structured data from JSON-LD,
following the Schema.org Recipe specification.
"""

import meta_oxide
import pytest


class TestRecipeBasic:
    """Test basic Recipe extraction with minimal fields"""

    def test_recipe_minimal(self):
        """Test extracting Recipe with only required name field"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "Recipe",
                "name": "Chocolate Chip Cookies"
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["@type"] == "Recipe"
        assert objects[0]["name"] == "Chocolate Chip Cookies"

    def test_recipe_with_description(self):
        """Test Recipe with name and description"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "Recipe",
                "name": "Classic Lasagna",
                "description": "A traditional Italian lasagna with layers of pasta, meat sauce, and cheese"
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["@type"] == "Recipe"
        assert objects[0]["name"] == "Classic Lasagna"
        assert (
            objects[0]["description"]
            == "A traditional Italian lasagna with layers of pasta, meat sauce, and cheese"
        )

    def test_recipe_with_single_image(self):
        """Test Recipe with a single image URL"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "Recipe",
                "name": "Banana Bread",
                "image": "https://example.com/banana-bread.jpg"
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["name"] == "Banana Bread"
        assert objects[0]["image"] == "https://example.com/banana-bread.jpg"

    def test_recipe_with_multiple_images(self):
        """Test Recipe with multiple images as array"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "Recipe",
                "name": "Pasta Carbonara",
                "image": [
                    "https://example.com/carbonara-1.jpg",
                    "https://example.com/carbonara-2.jpg",
                    "https://example.com/carbonara-3.jpg"
                ]
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["name"] == "Pasta Carbonara"
        # Arrays are returned as JSON strings in current implementation
        assert "image" in objects[0]


class TestRecipeIngredients:
    """Test Recipe ingredient extraction"""

    def test_recipe_with_ingredients_array(self):
        """Test Recipe with multiple ingredients"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "Recipe",
                "name": "Simple Omelette",
                "recipeIngredient": [
                    "3 eggs",
                    "2 tablespoons butter",
                    "Salt and pepper to taste",
                    "1/4 cup shredded cheese"
                ]
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["@type"] == "Recipe"
        assert objects[0]["name"] == "Simple Omelette"
        # Array property should be present
        assert "recipeIngredient" in objects[0]

    def test_recipe_with_single_ingredient(self):
        """Test Recipe with a single ingredient"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "Recipe",
                "name": "Popcorn",
                "recipeIngredient": ["Popcorn kernels"]
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert "recipeIngredient" in objects[0]


class TestRecipeInstructions:
    """Test Recipe instruction extraction"""

    def test_recipe_with_text_instructions(self):
        """Test Recipe with instructions as single text block"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "Recipe",
                "name": "Toast",
                "recipeInstructions": "Place bread in toaster. Toast until golden brown. Remove and serve immediately."
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert (
            objects[0]["recipeInstructions"]
            == "Place bread in toaster. Toast until golden brown. Remove and serve immediately."
        )

    def test_recipe_with_step_instructions(self):
        """Test Recipe with instructions as array of steps"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "Recipe",
                "name": "Pancakes",
                "recipeInstructions": [
                    "Mix flour, sugar, baking powder in a bowl",
                    "Add milk, egg, and melted butter",
                    "Pour batter onto hot griddle",
                    "Flip when bubbles form",
                    "Cook until golden brown"
                ]
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert "recipeInstructions" in objects[0]


class TestRecipeTimes:
    """Test Recipe time fields (ISO 8601 duration format)"""

    def test_recipe_with_prep_time(self):
        """Test Recipe with preparation time"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "Recipe",
                "name": "Caesar Salad",
                "prepTime": "PT15M"
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["prepTime"] == "PT15M"

    def test_recipe_with_cook_time(self):
        """Test Recipe with cooking time"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "Recipe",
                "name": "Roast Chicken",
                "cookTime": "PT1H30M"
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["cookTime"] == "PT1H30M"

    def test_recipe_with_total_time(self):
        """Test Recipe with total time"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "Recipe",
                "name": "Slow Cooker Stew",
                "totalTime": "PT8H"
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["totalTime"] == "PT8H"

    def test_recipe_with_all_times(self):
        """Test Recipe with prep, cook, and total time"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "Recipe",
                "name": "Beef Stew",
                "prepTime": "PT20M",
                "cookTime": "PT2H",
                "totalTime": "PT2H20M"
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["prepTime"] == "PT20M"
        assert objects[0]["cookTime"] == "PT2H"
        assert objects[0]["totalTime"] == "PT2H20M"


class TestRecipeMetadata:
    """Test Recipe metadata fields"""

    def test_recipe_with_yield(self):
        """Test Recipe with recipeYield"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "Recipe",
                "name": "Apple Pie",
                "recipeYield": "8 servings"
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["recipeYield"] == "8 servings"

    def test_recipe_with_category(self):
        """Test Recipe with recipeCategory"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "Recipe",
                "name": "Chocolate Cake",
                "recipeCategory": "Dessert"
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["recipeCategory"] == "Dessert"

    def test_recipe_with_cuisine(self):
        """Test Recipe with recipeCuisine"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "Recipe",
                "name": "Spaghetti Bolognese",
                "recipeCuisine": "Italian"
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["recipeCuisine"] == "Italian"

    def test_recipe_with_date_published(self):
        """Test Recipe with datePublished"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "Recipe",
                "name": "Summer Salad",
                "datePublished": "2024-06-15"
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["datePublished"] == "2024-06-15"


class TestRecipeNutrition:
    """Test Recipe nutrition information"""

    def test_recipe_with_nutrition(self):
        """Test Recipe with nutrition object"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "Recipe",
                "name": "Grilled Salmon",
                "nutrition": {
                    "@type": "NutritionInformation",
                    "calories": "320 calories",
                    "proteinContent": "35g",
                    "fatContent": "18g",
                    "carbohydrateContent": "5g"
                }
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert "nutrition" in objects[0]


class TestRecipeAuthor:
    """Test Recipe author field"""

    def test_recipe_with_person_author(self):
        """Test Recipe with Person as author"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "Recipe",
                "name": "French Onion Soup",
                "author": {
                    "@type": "Person",
                    "name": "Julia Child"
                }
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert "author" in objects[0]

    def test_recipe_with_string_author(self):
        """Test Recipe with string author"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "Recipe",
                "name": "Beef Wellington",
                "author": "Gordon Ramsay"
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["author"] == "Gordon Ramsay"


class TestRecipeRating:
    """Test Recipe aggregateRating field"""

    def test_recipe_with_aggregate_rating(self):
        """Test Recipe with aggregateRating"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "Recipe",
                "name": "Best Brownies",
                "aggregateRating": {
                    "@type": "AggregateRating",
                    "ratingValue": "4.8",
                    "reviewCount": "245"
                }
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert "aggregateRating" in objects[0]


class TestRecipeComplete:
    """Test complete Recipe with all fields"""

    def test_recipe_complete(self):
        """Test Recipe with comprehensive field set"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "Recipe",
                "name": "Grandma's Apple Pie",
                "description": "A classic homemade apple pie recipe passed down through generations",
                "image": [
                    "https://example.com/apple-pie-1.jpg",
                    "https://example.com/apple-pie-2.jpg"
                ],
                "author": {
                    "@type": "Person",
                    "name": "Jane Smith"
                },
                "datePublished": "2024-01-15",
                "prepTime": "PT30M",
                "cookTime": "PT1H",
                "totalTime": "PT1H30M",
                "recipeYield": "8 servings",
                "recipeCategory": "Dessert",
                "recipeCuisine": "American",
                "recipeIngredient": [
                    "6 cups thinly sliced apples",
                    "3/4 cup white sugar",
                    "2 tablespoons all-purpose flour",
                    "3/4 teaspoon ground cinnamon",
                    "1/4 teaspoon ground nutmeg",
                    "1 recipe pastry for a 9 inch double crust pie"
                ],
                "recipeInstructions": [
                    "Preheat oven to 425 degrees F (220 degrees C)",
                    "Combine sugar, flour, cinnamon, and nutmeg in a bowl",
                    "Mix in apples until evenly coated",
                    "Place bottom crust in pie pan and fill with apple mixture",
                    "Cover with top crust and seal edges",
                    "Bake for 40-50 minutes until crust is golden brown"
                ],
                "nutrition": {
                    "@type": "NutritionInformation",
                    "calories": "410 calories",
                    "carbohydrateContent": "58g",
                    "fatContent": "19g",
                    "proteinContent": "4g"
                },
                "aggregateRating": {
                    "@type": "AggregateRating",
                    "ratingValue": "4.9",
                    "reviewCount": "523"
                }
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        obj = objects[0]

        # Check basic fields
        assert obj["@type"] == "Recipe"
        assert obj["name"] == "Grandma's Apple Pie"
        assert (
            obj["description"]
            == "A classic homemade apple pie recipe passed down through generations"
        )

        # Check time fields
        assert obj["prepTime"] == "PT30M"
        assert obj["cookTime"] == "PT1H"
        assert obj["totalTime"] == "PT1H30M"

        # Check metadata
        assert obj["recipeYield"] == "8 servings"
        assert obj["recipeCategory"] == "Dessert"
        assert obj["recipeCuisine"] == "American"
        assert obj["datePublished"] == "2024-01-15"

        # Check nested objects exist
        assert "author" in obj
        assert "nutrition" in obj
        assert "aggregateRating" in obj
        assert "recipeIngredient" in obj
        assert "recipeInstructions" in obj
        assert "image" in obj


class TestRecipeEdgeCases:
    """Test edge cases for Recipe extraction"""

    def test_recipe_empty_fields(self):
        """Test Recipe with some empty/null fields"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "Recipe",
                "name": "Simple Recipe",
                "description": null,
                "recipeIngredient": []
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["name"] == "Simple Recipe"

    def test_multiple_recipes(self):
        """Test extracting multiple Recipe objects"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "Recipe",
                "name": "Recipe One"
            }
            </script>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "Recipe",
                "name": "Recipe Two"
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 2
        assert objects[0]["name"] == "Recipe One"
        assert objects[1]["name"] == "Recipe Two"

    def test_recipe_in_graph(self):
        """Test Recipe within @graph array"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@graph": [
                    {
                        "@type": "Recipe",
                        "name": "Pasta Recipe"
                    },
                    {
                        "@type": "Person",
                        "name": "Chef Name"
                    }
                ]
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 2
        recipe = next(obj for obj in objects if obj.get("@type") == "Recipe")
        assert recipe["name"] == "Pasta Recipe"


class TestRecipeIntegration:
    """Test Recipe integration with extract_all()"""

    def test_extract_all_includes_recipe(self):
        """Test that extract_all() properly includes Recipe objects"""
        html = """
        <html>
        <head>
            <title>Recipe Page</title>
            <meta property="og:title" content="Best Recipe Ever">
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "Recipe",
                "name": "Perfect Pancakes",
                "description": "The fluffiest pancakes you'll ever make"
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        data = meta_oxide.extract_all(html)

        assert "jsonld" in data
        assert len(data["jsonld"]) == 1
        assert data["jsonld"][0]["@type"] == "Recipe"
        assert data["jsonld"][0]["name"] == "Perfect Pancakes"


if __name__ == "__main__":
    pytest.main([__file__, "-v"])