Unverified Commit c3e2249a authored by narugo1992's avatar narugo1992 Committed by GitHub
Browse files

Merge pull request #102 from deepghs/dev/metadata 

dev(narugo): refactor imgutils.metadata module
parents 968ecf7c ac8c130c

.github/workflows/release_test.yml

+1 −1
Original line number Diff line number Diff line
@@ -38,7 +38,7 @@ jobs: 
          make package

          ls -al dist

      - name: Upload packed files to artifacts

        uses: actions/upload-artifact@v2

        uses: actions/upload-artifact@v3

        with:

          name: build-artifacts-source-pack

          path: ./dist/*

docs/source/api_doc/metadata/geninfo.rst

0 → 100644
+50 −0
Original line number Diff line number Diff line 
imgutils.metadata.geninfo

==========================================



.. currentmodule:: imgutils.metadata.geninfo



.. automodule:: imgutils.metadata.geninfo





read_geninfo_parameters

----------------------------------------------------------



.. autofunction:: read_geninfo_parameters







read_geninfo_exif

----------------------------------------------------------



.. autofunction:: read_geninfo_exif







read_geninfo_gif

----------------------------------------------------------



.. autofunction:: read_geninfo_gif







write_geninfo_parameters

----------------------------------------------------------



.. autofunction:: write_geninfo_parameters







write_geninfo_exif

----------------------------------------------------------



.. autofunction:: write_geninfo_exif







write_geninfo_gif

----------------------------------------------------------



.. autofunction:: write_geninfo_gif

docs/source/api_doc/metadata/index.rst

0 → 100644
+14 −0
Original line number Diff line number Diff line 
imgutils.metadata

========================



.. currentmodule:: imgutils.metadata



.. automodule:: imgutils.metadata





.. toctree::

    :maxdepth: 3



    geninfo

    lsb

docs/source/api_doc/metadata/lsb.rst

0 → 100644
+79 −0
Original line number Diff line number Diff line 
imgutils.metadata.lsb

========================



.. currentmodule:: imgutils.metadata.lsb



.. automodule:: imgutils.metadata.lsb





read_lsb_raw_bytes

------------------------------------------------



.. autofunction:: read_lsb_raw_bytes







read_lsb_metadata

------------------------------------------------



.. autofunction:: read_lsb_metadata







write_lsb_raw_bytes

------------------------------------------------



.. autofunction:: write_lsb_raw_bytes







write_lsb_metadata

------------------------------------------------



.. autofunction:: write_lsb_metadata







LSBReadError

------------------------------------------------



.. autoclass:: LSBReadError







LSBExtractor

------------------------------------------------



.. autoclass:: LSBExtractor

    :members: __init__, get_one_byte, get_next_n_bytes, read_32bit_integer







ImageLsbDataExtractor

------------------------------------------------



.. autoclass:: ImageLsbDataExtractor

    :members: __init__, extract_data







serialize_pnginfo

------------------------------------------------



.. autofunction:: serialize_pnginfo







serialize_json

------------------------------------------------



.. autofunction:: serialize_json







inject_data

------------------------------------------------



.. autofunction:: inject_data

docs/source/api_doc/sd/metadata.rst

+8 −1
Original line number Diff line number Diff line
@@ -10,7 +10,7 @@ SDMetaData 
-------------------------



.. autoclass:: SDMetaData

    :members: __str__, pnginfo

    :members: __str__, text, pnginfo
@@ -28,3 +28,10 @@ get_sdmeta_from_image 






save_image_with_sdmeta

------------------------------------------



.. autofunction:: save_image_with_sdmeta