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

"""
Tests for JSON-LD VideoObject type

Tests the extraction of Schema.org VideoObject structured data
"""

import meta_oxide
import pytest


class TestVideoObjectBasic:
    """Test basic VideoObject extraction"""

    def test_video_basic(self):
        """Test minimal video with name only"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "VideoObject",
                "name": "How to Code in Python"
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["@type"] == "VideoObject"
        assert objects[0]["name"] == "How to Code in Python"

    def test_video_with_description(self):
        """Test video with name and description"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "VideoObject",
                "name": "Python Tutorial",
                "description": "Learn Python programming from scratch"
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["@type"] == "VideoObject"
        assert objects[0]["name"] == "Python Tutorial"
        assert objects[0]["description"] == "Learn Python programming from scratch"


class TestVideoObjectUrls:
    """Test VideoObject URL fields"""

    def test_video_with_urls(self):
        """Test video with contentUrl and embedUrl"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "VideoObject",
                "name": "Sample Video",
                "contentUrl": "https://example.com/video.mp4",
                "embedUrl": "https://example.com/embed/video123",
                "url": "https://example.com/watch?v=123"
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["@type"] == "VideoObject"
        assert objects[0]["name"] == "Sample Video"
        assert objects[0]["contentUrl"] == "https://example.com/video.mp4"
        assert objects[0]["embedUrl"] == "https://example.com/embed/video123"
        assert objects[0]["url"] == "https://example.com/watch?v=123"


class TestVideoObjectMetadata:
    """Test VideoObject metadata fields"""

    def test_video_with_metadata(self):
        """Test video with duration and uploadDate"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "VideoObject",
                "name": "Cooking Tutorial",
                "description": "How to make pasta",
                "uploadDate": "2024-01-15T10:00:00Z",
                "duration": "PT5M30S"
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["@type"] == "VideoObject"
        assert objects[0]["name"] == "Cooking Tutorial"
        assert objects[0]["uploadDate"] == "2024-01-15T10:00:00Z"
        assert objects[0]["duration"] == "PT5M30S"

    def test_video_with_dimensions(self):
        """Test video with width and height"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "VideoObject",
                "name": "HD Video",
                "width": 1920,
                "height": 1080
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["@type"] == "VideoObject"
        assert objects[0]["width"] == 1920
        assert objects[0]["height"] == 1080


class TestVideoObjectThumbnails:
    """Test VideoObject thumbnail handling"""

    def test_video_with_thumbnail_string(self):
        """Test video with single thumbnail URL as string"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "VideoObject",
                "name": "Video with Thumbnail",
                "thumbnailUrl": "https://example.com/thumbnail.jpg"
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["@type"] == "VideoObject"
        assert objects[0]["thumbnailUrl"] == "https://example.com/thumbnail.jpg"

    def test_video_with_thumbnail_array(self):
        """Test video with multiple thumbnail URLs"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "VideoObject",
                "name": "Video with Multiple Thumbnails",
                "thumbnailUrl": [
                    "https://example.com/thumb1.jpg",
                    "https://example.com/thumb2.jpg",
                    "https://example.com/thumb3.jpg"
                ]
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["@type"] == "VideoObject"
        # Array values are currently returned as JSON strings per codebase pattern
        assert "thumbnailUrl" in objects[0]


class TestVideoObjectStats:
    """Test VideoObject interaction statistics"""

    def test_video_with_stats(self):
        """Test video with interactionStatistic for view count"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "VideoObject",
                "name": "Popular Video",
                "interactionStatistic": {
                    "@type": "InteractionCounter",
                    "interactionType": "https://schema.org/WatchAction",
                    "userInteractionCount": 12345
                }
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["@type"] == "VideoObject"
        assert objects[0]["name"] == "Popular Video"
        # Complex objects are returned as JSON strings per codebase pattern
        assert "interactionStatistic" in objects[0]


class TestVideoObjectAuthorship:
    """Test VideoObject author and publisher fields"""

    def test_video_with_author(self):
        """Test video with author (Person)"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "VideoObject",
                "name": "Tutorial Video",
                "author": {
                    "@type": "Person",
                    "name": "Jane Doe",
                    "url": "https://example.com/jane"
                }
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["@type"] == "VideoObject"
        assert objects[0]["name"] == "Tutorial Video"
        # Complex objects are returned as JSON strings per codebase pattern
        assert "author" in objects[0]

    def test_video_with_publisher(self):
        """Test video with publisher (Organization)"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "VideoObject",
                "name": "Corporate Video",
                "publisher": {
                    "@type": "Organization",
                    "name": "Acme Corp",
                    "logo": {
                        "@type": "ImageObject",
                        "url": "https://acme.com/logo.png"
                    }
                }
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["@type"] == "VideoObject"
        assert objects[0]["name"] == "Corporate Video"
        # Complex objects are returned as JSON strings per codebase pattern
        assert "publisher" in objects[0]


class TestVideoObjectComplete:
    """Test complete VideoObject with all fields"""

    def test_video_complete(self):
        """Test video with all supported fields"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "VideoObject",
                "name": "Complete Video Example",
                "description": "A comprehensive video with all metadata",
                "thumbnailUrl": "https://example.com/thumbnail.jpg",
                "uploadDate": "2024-01-15T10:00:00Z",
                "duration": "PT10M30S",
                "contentUrl": "https://example.com/video.mp4",
                "embedUrl": "https://example.com/embed/video",
                "url": "https://example.com/watch?v=abc123",
                "width": 1920,
                "height": 1080,
                "author": {
                    "@type": "Person",
                    "name": "John Creator"
                },
                "publisher": {
                    "@type": "Organization",
                    "name": "Video Platform Inc",
                    "logo": {
                        "@type": "ImageObject",
                        "url": "https://platform.com/logo.png"
                    }
                },
                "interactionStatistic": {
                    "@type": "InteractionCounter",
                    "interactionType": "https://schema.org/WatchAction",
                    "userInteractionCount": 999999
                }
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

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

        assert video["@type"] == "VideoObject"
        assert video["name"] == "Complete Video Example"
        assert video["description"] == "A comprehensive video with all metadata"
        assert video["thumbnailUrl"] == "https://example.com/thumbnail.jpg"
        assert video["uploadDate"] == "2024-01-15T10:00:00Z"
        assert video["duration"] == "PT10M30S"
        assert video["contentUrl"] == "https://example.com/video.mp4"
        assert video["embedUrl"] == "https://example.com/embed/video"
        assert video["url"] == "https://example.com/watch?v=abc123"
        assert video["width"] == 1920
        assert video["height"] == 1080
        # Complex objects are present
        assert "author" in video
        assert "publisher" in video
        assert "interactionStatistic" in video


class TestVideoObjectEdgeCases:
    """Test edge cases for VideoObject"""

    def test_video_empty_optional_fields(self):
        """Test that optional fields can be omitted"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "VideoObject",
                "name": "Minimal Video"
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["@type"] == "VideoObject"
        assert objects[0]["name"] == "Minimal Video"
        # Optional fields should not be present if not provided
        assert "description" not in objects[0]
        assert "duration" not in objects[0]
        assert "uploadDate" not in objects[0]

    def test_video_in_graph(self):
        """Test VideoObject within @graph"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@graph": [
                    {
                        "@type": "VideoObject",
                        "name": "First Video"
                    },
                    {
                        "@type": "VideoObject",
                        "name": "Second Video"
                    }
                ]
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 2
        assert objects[0]["@type"] == "VideoObject"
        assert objects[0]["name"] == "First Video"
        assert objects[1]["@type"] == "VideoObject"
        assert objects[1]["name"] == "Second Video"


class TestVideoObjectIntegration:
    """Test VideoObject integration with extract_all()"""

    def test_extract_all_includes_video(self):
        """Test that extract_all() includes VideoObject"""
        html = """
        <html>
        <head>
            <title>Video Page</title>
            <meta property="og:title" content="OG Title">
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "VideoObject",
                "name": "Test Video",
                "description": "A test video"
            }
            </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"] == "VideoObject"
        assert data["jsonld"][0]["name"] == "Test Video"

    def test_multiple_types_with_video(self):
        """Test VideoObject alongside other Schema.org types"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "VideoObject",
                "name": "Video Content"
            }
            </script>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "Article",
                "headline": "Article Content"
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

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


class TestVideoObjectRealWorld:
    """Test with real-world VideoObject examples"""

    def test_youtube_style_video(self):
        """Test YouTube-style VideoObject"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "VideoObject",
                "name": "Cat Videos Compilation 2024",
                "description": "Funny cat videos compilation",
                "thumbnailUrl": [
                    "https://i.ytimg.com/vi/abc123/maxresdefault.jpg",
                    "https://i.ytimg.com/vi/abc123/hqdefault.jpg"
                ],
                "uploadDate": "2024-01-20T15:30:00Z",
                "duration": "PT15M45S",
                "contentUrl": "https://www.youtube.com/v/abc123",
                "embedUrl": "https://www.youtube.com/embed/abc123",
                "interactionStatistic": {
                    "@type": "InteractionCounter",
                    "interactionType": "https://schema.org/WatchAction",
                    "userInteractionCount": 1234567
                }
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["@type"] == "VideoObject"
        assert objects[0]["name"] == "Cat Videos Compilation 2024"
        assert objects[0]["duration"] == "PT15M45S"

    def test_vimeo_style_video(self):
        """Test Vimeo-style VideoObject"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "VideoObject",
                "name": "Creative Short Film",
                "description": "An award-winning short film",
                "thumbnailUrl": "https://i.vimeocdn.com/video/123456.jpg",
                "uploadDate": "2024-02-01T12:00:00Z",
                "duration": "PT8M20S",
                "width": 1920,
                "height": 1080,
                "embedUrl": "https://player.vimeo.com/video/123456",
                "author": {
                    "@type": "Person",
                    "name": "Indie Filmmaker",
                    "url": "https://vimeo.com/indiefilmmaker"
                }
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["@type"] == "VideoObject"
        assert objects[0]["name"] == "Creative Short Film"
        assert objects[0]["width"] == 1920
        assert objects[0]["height"] == 1080


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