Skip to content

🧹 [code health improvement] add decode docstrings #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
schwehr merged 1 commit into from
Aug 5, 2026
Merged

🧹 [code health improvement] add decode docstrings #21

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 26 additions & 1 deletion src/noaadata/cli/aisxmlbinmsg2py.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2968,7 +2968,6 @@ def buildDecodeParts(o, msgET, verbose=False, prefixName=False):
Returns:
None

TODO(schwehr):FIX: doc strings for each decode!
TODO(schwehr):FIX: check for a dac,fid, or efid. If exists, then this is an AIS Msg 8 payload
TODO(schwehr):May want to take a dictionary of already decoded fields to speed things that need prior info
for things like variable length arrays
Expand All @@ -2992,6 +2991,32 @@ def buildDecodeParts(o, msgET, verbose=False, prefixName=False):
type = field.attrib["type"]

o.write("def " + baseName + name + "(bv, validate=False):\n")

# doc string
desc = field[0].text.replace("\n", " ") # get ride of new lines
o.write(
" '''Decode part "
+ name
+ " for "
+ msgET.attrib["name"]
+ " message.\n\n"
)
o.write(" - " + name + "(" + type + "): " + desc)
if len(field.xpath("required")) == 1:
o.write(
' (field automatically set to "'
+ field.xpath("required")[0].text
+ '")'
)
o.write("\n")
o.write(" @type bv: BitVector\n")
o.write(" @param bv: Bits defining a message\n")
o.write(" @type validate: bool\n")
o.write(" @param validate: Set to true to cause checking to occur\n")
o.write(" @rtype: dict\n")
o.write(" @return: dict with one key set to the decoded value\n")
o.write(" '''\n")

# Follow the same convention of decoding into a dict so that code is the same
# o.write(' r={};')
o.write(" return ")
Expand Down