Merge pull request #236 from cjcodeproj/integration

Integration to Main (v0.2.9)

Author: cjcodeproj

CHANGELOG.md

@@ -1,6 +1,16 @@
 medialibrary CHANGELOG
 ======================
 
+## RELEASE 0.2.9 (Aug, 2025)
+
+ - [medialibrary-234](https://github.com/cjcodeproj/medialibrary/issues/234) Release 0.2.9
+ - [medialibrary-232](https://github.com/cjcodeproj/medialibrary/issues/232) pylint error in audio/elements/internal.py
+ - [medialibrary-223](https://github.com/cjcodeproj/medialibrary/issues/223) Generic keywords do not strip leading or trailing whitespace
+ - [medialibrary-230](https://github.com/cjcodeproj/medialibrary/issues/230) Support variant data structure
+ - [medialibrary-203](https://github.com/cjcodeproj/medialibrary/issues/203) Internal function definition has bad default value
+ - [medialibrary-227](https://github.com/cjcodeproj/medialibrary/issues/227) Re-factor composer for new XML structure
+
+
 ## RELEASE 0.2.7
 
  - [medialibrary-220](https://github.com/cjcodeproj/medialibrary/issues/220) Release 0.2.7

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "medialibrary"
-version = "0.2.7"
+version = "0.2.9"
 description = "Package for reading vtmedia XML files describing a movie/music media library"
 readme = "README.md"
 requires-python = ">3.8"

src/media/data/media/contents/audio/elements/internal.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 
 #
-# Copyright 2024 Chris Josephes
+# Copyright 2025 Chris Josephes
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -27,7 +27,7 @@
 '''
 
 # pylint: disable=too-few-public-methods
-# pylint: disable=R0801
+# pylint: disable=R0801, W0613
 
 from media.data.media.contents.generic.catalog import AbstractCatalog
 from media.data.nouns import noun_dispatcher
@@ -56,8 +56,6 @@ def _extract_catalog_from(self, in_parent):
             self.catalog = ElementCatalog(None)
             if in_parent.catalog.artists is not None:
                 self.catalog.artists = in_parent.catalog.artists
-            if in_parent.catalog.composers is not None:
-                self.catalog.composers = in_parent.catalog.composers
 
 
 class ElementTitle():
@@ -86,31 +84,23 @@ class ElementCatalog(AbstractCatalog):
     def __init__(self, in_element):
         super().__init__()
         self.artists = []
-        self.composers = []
-        if in_element is not None:
-            self._process(in_element)
+        # We can't call process here, because it'll
+        # it would run prematurely before subclass
+        # __init__ completes.
 
     def _process(self, in_element):
         super()._process(in_element)
         for child in in_element:
             e_name = Namespaces.ns_strip(child.tag)
             if e_name == 'artists':
                 self._process_artists(child)
-            elif e_name == 'composers':
-                self._process_composers(child)
 
     def _process_artists(self, in_element):
         for child in in_element:
             e_name = Namespaces.ns_strip(child.tag)
             if e_name == 'artist':
                 self.artists.append(noun_dispatcher(child))
 
-    def _process_composers(self, in_element):
-        for child in in_element:
-            e_name = Namespaces.ns_strip(child.tag)
-            if e_name == 'composer':
-                self.composers.append(noun_dispatcher(child))
-
 
 class ElementTechnical():
     '''

src/media/data/media/contents/audio/elements/song.py

@@ -31,8 +31,9 @@
 
 from media.data.media.contents.genericv.technical import process_iso_duration
 from media.data.media.contents.audio.elements import (
-        AbstractElement, ElementTechnical
+        AbstractElement, ElementCatalog, ElementTechnical
         )
+from media.data.nouns import noun_dispatcher
 from media.xml.namespaces import Namespaces
 
 
@@ -54,12 +55,64 @@ def _process(self, in_element=None):
             e_name = Namespaces.ns_strip(child.tag)
             if e_name == 'technical':
                 self.technical = SongTechnical(child)
+            elif e_name == 'catalog':
+                self.catalog = SongCatalog(child)
         self._post_load_process()
 
     def _post_load_process(self):
         if not self.catalog:
             self._extract_catalog_from(self.parent_o)
 
+    def _extract_catalog_from(self, in_parent):
+        super()._extract_catalog_from(in_parent)
+        if in_parent.catalog is not None:
+            if in_parent.catalog.composers is not None:
+                self.catalog.composers = in_parent.catalog.composers
+
+
+class SongCatalog(ElementCatalog):
+    '''
+    Catalog specific to a song.
+    '''
+    def __init__(self, in_element):
+        super().__init__(in_element)
+        self.composers = []
+        if in_element is not None:
+            self._process(in_element)
+
+    def _process(self, in_element):
+        super()._process(in_element)
+        for child in in_element:
+            e_name = Namespaces.ns_strip(child.tag)
+            if e_name == 'composers':
+                self._process_composers(child)
+
+    def _process_composers(self, in_element):
+        for child in in_element:
+            self.composers.append(SongComposer(child))
+
+
+class SongComposer():
+    '''
+    Object representing a composer.
+    '''
+    def __init__(self, in_element):
+        self.name = None
+        self.publishers = []
+        self.rights = None
+        if in_element is not None:
+            self._process(in_element)
+
+    def _process(self, in_element):
+        for child in in_element:
+            e_name = Namespaces.ns_strip(child.tag)
+            if e_name == 'name':
+                self.name = noun_dispatcher(child)
+            elif e_name == 'publisher':
+                self.publishers.append(child.text)
+            elif e_name == 'rights':
+                self.rights = child.text
+
 
 class SongTechnical(ElementTechnical):
     '''

src/media/data/media/contents/generic/keywords.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 
 #
-# Copyright 2024 Chris Josephes
+# Copyright 2025 Chris Josephes
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -203,7 +203,7 @@ class GenericKeyword(AbstractKeyword):
     '''
     def __init__(self, in_element):
         super().__init__(in_element)
-        self.value = in_element.text
+        self.value = in_element.text.strip()
         self.sort_value = self.value.casefold()
         self.type = 'generic'
 

src/media/data/media/contents/genericv/variants.py

@@ -0,0 +1,103 @@
+#!/usr/bin/env python
+
+#
+# Copyright 2025 Chris Josephes
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+#
+
+'''
+Code to handle technical aspects of a vidsual format media
+(movies, television)
+'''
+
+# pylint: disable=too-few-public-methods
+
+from media.xml.namespaces import Namespaces
+from media.data.media.contents.genericv.technical import Technical
+
+
+class VariantPool():
+    '''
+    A class to handle variant loading.
+    '''
+    @classmethod
+    def read_variants(cls, in_element):
+        '''
+        Read a variants element structure and create
+        the variant child objects.
+        '''
+        variants = []
+        if in_element is not None:
+            for child in in_element:
+                tagname = Namespaces.ns_strip(child.tag)
+                if tagname == 'original':
+                    variants.append(OriginalVariant(child))
+                elif tagname == 'variant':
+                    variants.append(Variant(child))
+        return variants
+
+
+class AbstractVariant():
+    '''
+    Abstract Variant class.
+    '''
+    def __init__(self):
+        self.id = ''
+        self.name = ''
+        self.notes = ''
+
+    def _process_xml_stream(self, in_element):
+        if 'id' in in_element.attrib:
+            self.id = in_element.attrib['id']
+        for child in in_element:
+            tagname = Namespaces.ns_strip(child.tag)
+            if tagname == 'name':
+                self.name = child.text
+            elif tagname == 'notes':
+                self.notes = child.text
+
+
+class OriginalVariant(AbstractVariant):
+    '''
+    Original type Variant class
+    '''
+    def __init__(self, in_element):
+        super().__init__()
+        if in_element is not None:
+            self._process_xml_stream(in_element)
+
+
+class Variant(AbstractVariant):
+    '''
+    Regular type Variant class.
+    '''
+
+    def __init__(self, in_element):
+        super().__init__()
+        self.techincal = None
+        if in_element is not None:
+            self._process_xml_stream(in_element)
+
+    def _process_xml_stream(self, in_element):
+        super()._process_xml_stream(in_element)
+        for child in in_element:
+            tagname = Namespaces.ns_strip(child.tag)
+            if tagname == 'technical':
+                self.technical = Technical(child)

src/media/data/media/contents/movie/internal.py

@@ -34,6 +34,7 @@
 from media.data.media.contents.generic.story import Story
 from media.data.media.contents.genericv.crew import Crew
 from media.data.media.contents.genericv.technical import Technical
+from media.data.media.contents.genericv.variants import VariantPool
 from media.data.media.contents.movie.classification import Classification
 from media.general.sorting.index import ContentIndex
 
@@ -43,6 +44,7 @@ class Movie(AbstractContent):
     def __init__(self, in_element):
         super().__init__()
         self.technical = None
+        self.variants = []
         self.crew = None
         self.s_index = None
         self._process(in_element)
@@ -59,13 +61,15 @@ def _process(self, in_element):
         for child in in_element:
             if child.tag == Namespaces.nsf('movie') + 'classification':
                 self.classification = Classification(child)
-            if child.tag == Namespaces.nsf('movie') + 'technical':
+            elif child.tag == Namespaces.nsf('movie') + 'technical':
                 self.technical = Technical(child)
-            if child.tag == Namespaces.nsf('movie') + 'story':
+            elif child.tag == Namespaces.nsf('movie') + 'story':
                 self.story = Story(child)
-            if child.tag == Namespaces.nsf('movie') + 'description':
+            elif child.tag == Namespaces.nsf('movie') + 'description':
                 self.story = Story(child)
-            if child.tag == Namespaces.nsf('movie') + 'crew':
+            elif child.tag == Namespaces.nsf('movie') + 'variants':
+                self.variants = VariantPool.read_variants(child)
+            elif child.tag == Namespaces.nsf('movie') + 'crew':
                 self.crew = Crew(child)
         self._post_load_process()
 

src/media/tools/movies/common.py

@@ -200,7 +200,7 @@ def _stats(self):
             out += f"  {'Sample count':12s} : {wrk_c:5d} ({wrk_p:5.2f}%)\n"
         return out
 
-    def _out_batch(self, batch, sort_field=1):
+    def _out_batch(self, batch, sort_field=Batch.S_TITLE):
         '''
         Generate the output for a single batch.
         '''

test/media/data/media/contents/audio/elements/test_song.py

@@ -50,7 +50,10 @@
      <artist><gn>Blake</gn><fn>Drake</fn></artist>
     </artists>
     <composers>
-     <composer><gn>Chad</gn><fn>Brooks</fn></composer>
+     <composer>
+       <name><gn>Chad</gn><fn>Brooks</fn></name>
+       <publisher>Drunken Tirade Music, LLC</publisher>
+     </composer>
     </composers>
    </catalog>
    <technical>
@@ -133,14 +136,14 @@ def test_song_catalog_first_composer_obj(self):
         Verify object of first composer passed.
         '''
         song_comp_one = self.album.elements[0].catalog.composers[0]
-        self.assertIsInstance(song_comp_one, PersonalName)
+        self.assertIsInstance(song_comp_one.name, PersonalName)
 
     def test_song_catalog_first_composer_val(self):
         '''
         Verify value of first composer passed.
         '''
         song_comp_one = self.album.elements[0].catalog.composers[0]
-        self.assertEqual(str(song_comp_one), 'Chad Brooks')
+        self.assertEqual(str(song_comp_one.name), 'Chad Brooks')
 
 
 class TestAlbumElementInheritedCatalog(unittest.TestCase):