Documentation

This commit is contained in:
Jamie Hardt
2022-11-23 22:49:38 -08:00
parent 9f8fc87d17
commit 40aee91162

View File

@@ -3,7 +3,7 @@ import struct
import os import os
from collections import namedtuple from collections import namedtuple
from typing import Optional from typing import Optional, Generator, Any
import pathlib import pathlib
@@ -154,14 +154,13 @@ class WavInfoReader:
ixml_data = self._find_chunk_data(b'iXML', f, default_none=True) ixml_data = self._find_chunk_data(b'iXML', f, default_none=True)
return None if ixml_data is None else WavIXMLFormat(ixml_data.rstrip(b'\0')) return None if ixml_data is None else WavIXMLFormat(ixml_data.rstrip(b'\0'))
def walk(self): def walk(self) -> Generator[str,str,Any]:
""" """
Walk all of the available metadata fields. Walk all of the available metadata fields.
:yields: tuples of the *scope*, *key*, and *value* of :yields: tuples of the *scope*, *key*, and *value* of
each metadatum. The *scope* value will be one of each metadatum. The *scope* value will be one of
"fmt", "data", "ixml", "bext", "info" or "adm". "fmt", "data", "ixml", "bext", "info" or "adm".
""" """
scopes = ('fmt', 'data', 'ixml', 'bext', 'info', 'adm') scopes = ('fmt', 'data', 'ixml', 'bext', 'info', 'adm')