Skip to content

Consider an extensible Field type for sheet importers #8

@3noch

Description

@3noch

I've found myself needing to generate documentation for the sheet importer. Since there's a large overlap between the sheet definition and the documentation of each field, it's nice to put everything in one place:

fields = (
    FieldDoc('Column Header', 'column_key', parser, 'Column description', is_required=True),
)

But this seems like scope creep for Tribune itself. Perhaps we could address this by making the Field type extensible. This could be accomplished several ways.

  1. Use make it a super class

Instead of using a namedtuple, turn Field into a class that can be inherited. As long as children classes have the necessary fields of header, key, parser, they can add as much as they want, including documentation metadata.

  1. Allow Field to take an additional metadata field.

Keep Field as a namedtuple but add one more field to be used for anything the end-coder needs:

Field = namedtuple('Field', ['label', 'key', 'parser', 'metadata'])

Ideally we'd make this metadata field optional and default it to None or something. That can be achieved several ways that I won't mention here.

The nice thing about option #2 is that in maintains the immutable nature of tuples and it's still very simple.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions