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
"""
Tests for JSON-LD FAQPage extraction (TDD approach)

Following Schema.org FAQPage specification:
https://schema.org/FAQPage
"""

import meta_oxide
import pytest


class TestFAQPageBasic:
    """Test basic FAQPage extraction"""

    def test_faqpage_basic(self):
        """Test minimal FAQPage with one Q&A"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "FAQPage",
                "mainEntity": [
                    {
                        "@type": "Question",
                        "name": "What is JSON-LD?",
                        "acceptedAnswer": {
                            "@type": "Answer",
                            "text": "JSON-LD is a lightweight Linked Data format."
                        }
                    }
                ]
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["@type"] == "FAQPage"
        assert "mainEntity" in objects[0]
        # mainEntity should be a JSON string containing the array
        assert "Question" in str(objects[0]["mainEntity"])


class TestFAQPageMultipleQuestions:
    """Test FAQPage with multiple Q&A pairs"""

    def test_faqpage_multiple_questions(self):
        """Test FAQPage with multiple Q&A pairs"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "FAQPage",
                "mainEntity": [
                    {
                        "@type": "Question",
                        "name": "What is Schema.org?",
                        "acceptedAnswer": {
                            "@type": "Answer",
                            "text": "Schema.org is a collaborative initiative to create structured data schemas."
                        }
                    },
                    {
                        "@type": "Question",
                        "name": "Why use structured data?",
                        "acceptedAnswer": {
                            "@type": "Answer",
                            "text": "Structured data helps search engines understand your content better."
                        }
                    },
                    {
                        "@type": "Question",
                        "name": "How to implement FAQPage?",
                        "acceptedAnswer": {
                            "@type": "Answer",
                            "text": "Use JSON-LD script tags with FAQPage schema."
                        }
                    }
                ]
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["@type"] == "FAQPage"
        assert "mainEntity" in objects[0]
        # Should contain multiple questions
        main_entity_str = str(objects[0]["mainEntity"])
        assert "What is Schema.org?" in main_entity_str or "Schema.org" in main_entity_str
        assert "Why use structured data?" in main_entity_str or "structured data" in main_entity_str


class TestFAQPageWithMetadata:
    """Test FAQPage with additional metadata"""

    def test_faqpage_with_metadata(self):
        """Test FAQPage with author, datePublished"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "FAQPage",
                "name": "Common Questions About SEO",
                "description": "Frequently asked questions about search engine optimization",
                "datePublished": "2024-01-15",
                "author": {
                    "@type": "Person",
                    "name": "John SEO Expert"
                },
                "mainEntity": [
                    {
                        "@type": "Question",
                        "name": "What is SEO?",
                        "acceptedAnswer": {
                            "@type": "Answer",
                            "text": "SEO stands for Search Engine Optimization."
                        }
                    }
                ]
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["@type"] == "FAQPage"
        assert objects[0]["name"] == "Common Questions About SEO"
        assert (
            objects[0]["description"]
            == "Frequently asked questions about search engine optimization"
        )
        assert objects[0]["datePublished"] == "2024-01-15"
        assert "author" in objects[0]


class TestFAQPageComplete:
    """Test complete FAQPage with all fields"""

    def test_faqpage_complete(self):
        """Test FAQPage with all possible fields"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "FAQPage",
                "name": "Complete FAQ Page",
                "description": "A comprehensive FAQ about our services",
                "url": "https://example.com/faq",
                "datePublished": "2024-01-15T10:00:00Z",
                "author": {
                    "@type": "Organization",
                    "name": "Example Corp",
                    "url": "https://example.com"
                },
                "mainEntity": [
                    {
                        "@type": "Question",
                        "name": "What services do you offer?",
                        "acceptedAnswer": {
                            "@type": "Answer",
                            "text": "We offer web development, SEO, and consulting services."
                        }
                    },
                    {
                        "@type": "Question",
                        "name": "How can I contact you?",
                        "acceptedAnswer": {
                            "@type": "Answer",
                            "text": "You can reach us via email at contact@example.com or call us at 555-1234."
                        }
                    }
                ]
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

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

        assert faq["@type"] == "FAQPage"
        assert faq["name"] == "Complete FAQ Page"
        assert faq["description"] == "A comprehensive FAQ about our services"
        assert faq["url"] == "https://example.com/faq"
        assert faq["datePublished"] == "2024-01-15T10:00:00Z"
        assert "author" in faq
        assert "mainEntity" in faq


class TestFAQPageEdgeCases:
    """Test edge cases for FAQPage"""

    def test_faqpage_empty_mainentity(self):
        """Test FAQPage with empty mainEntity array"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "FAQPage",
                "name": "Empty FAQ",
                "mainEntity": []
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["@type"] == "FAQPage"
        assert objects[0]["name"] == "Empty FAQ"
        assert "mainEntity" in objects[0]

    def test_faqpage_minimal(self):
        """Test minimal FAQPage with just type"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "FAQPage"
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["@type"] == "FAQPage"

    def test_faqpage_with_rich_answer(self):
        """Test FAQPage with rich answer content (HTML in text)"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "FAQPage",
                "mainEntity": [
                    {
                        "@type": "Question",
                        "name": "How to format code?",
                        "acceptedAnswer": {
                            "@type": "Answer",
                            "text": "<p>Use the <code>code</code> tag for inline code.</p>"
                        }
                    }
                ]
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["@type"] == "FAQPage"
        assert "mainEntity" in objects[0]


class TestFAQPageIntegration:
    """Test FAQPage integration with extract_all()"""

    def test_extract_all_includes_faqpage(self):
        """Test that extract_all() properly extracts FAQPage"""
        html = """
        <html>
        <head>
            <title>FAQ - Example Site</title>
            <meta name="description" content="Frequently asked questions">
            <meta property="og:title" content="FAQ Page">
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "FAQPage",
                "name": "Product FAQ",
                "mainEntity": [
                    {
                        "@type": "Question",
                        "name": "Is shipping free?",
                        "acceptedAnswer": {
                            "@type": "Answer",
                            "text": "Yes, we offer free shipping on orders over $50."
                        }
                    }
                ]
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        data = meta_oxide.extract_all(html)

        assert "meta" in data
        assert "opengraph" in data
        assert "jsonld" in data

        assert len(data["jsonld"]) == 1
        assert data["jsonld"][0]["@type"] == "FAQPage"
        assert data["jsonld"][0]["name"] == "Product FAQ"

    def test_multiple_jsonld_with_faqpage(self):
        """Test FAQPage alongside other JSON-LD types"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "Organization",
                "name": "Example Corp"
            }
            </script>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "FAQPage",
                "mainEntity": [
                    {
                        "@type": "Question",
                        "name": "Who are you?",
                        "acceptedAnswer": {
                            "@type": "Answer",
                            "text": "We are Example Corp."
                        }
                    }
                ]
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 2
        types = [obj["@type"] for obj in objects]
        assert "Organization" in types
        assert "FAQPage" in types


class TestFAQPageRealWorld:
    """Test real-world FAQPage examples"""

    def test_ecommerce_faq(self):
        """Test e-commerce FAQ page"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "FAQPage",
                "name": "Shipping & Returns FAQ",
                "mainEntity": [
                    {
                        "@type": "Question",
                        "name": "What is your return policy?",
                        "acceptedAnswer": {
                            "@type": "Answer",
                            "text": "We accept returns within 30 days of purchase for a full refund."
                        }
                    },
                    {
                        "@type": "Question",
                        "name": "How long does shipping take?",
                        "acceptedAnswer": {
                            "@type": "Answer",
                            "text": "Standard shipping takes 5-7 business days. Express shipping takes 2-3 business days."
                        }
                    },
                    {
                        "@type": "Question",
                        "name": "Do you ship internationally?",
                        "acceptedAnswer": {
                            "@type": "Answer",
                            "text": "Yes, we ship to over 50 countries worldwide."
                        }
                    }
                ]
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["@type"] == "FAQPage"
        assert objects[0]["name"] == "Shipping & Returns FAQ"

    def test_technical_documentation_faq(self):
        """Test technical documentation FAQ"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "FAQPage",
                "name": "API Documentation FAQ",
                "description": "Common questions about our API",
                "url": "https://api.example.com/faq",
                "datePublished": "2024-01-15",
                "author": {
                    "@type": "Organization",
                    "name": "Example API Team"
                },
                "mainEntity": [
                    {
                        "@type": "Question",
                        "name": "How do I get an API key?",
                        "acceptedAnswer": {
                            "@type": "Answer",
                            "text": "Sign up for an account and navigate to the API Keys section in your dashboard."
                        }
                    },
                    {
                        "@type": "Question",
                        "name": "What are the rate limits?",
                        "acceptedAnswer": {
                            "@type": "Answer",
                            "text": "Free tier: 1000 requests/day. Pro tier: 100,000 requests/day."
                        }
                    }
                ]
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        faq = objects[0]
        assert faq["@type"] == "FAQPage"
        assert faq["name"] == "API Documentation FAQ"
        assert faq["description"] == "Common questions about our API"
        assert faq["url"] == "https://api.example.com/faq"


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