pynamodb / PynamoDB / 2831

95%

devel: 95%

push

travis-ci

<a href="https://github.com/pynamodb/PynamoDB/commit/<a class=hub.com/pynamodb/PynamoDB/commit/63b01ecf8987ed98e92d78c6abb8c94520ad6236">63b01ecf8<a href="https://github.com/pynamodb/PynamoDB/commit/63b01ecf8987ed98e92d78c6abb8c94520ad6236">&quot;&gt;Make (GS,LS)Index an indexable type in runtime (#769)

Following </a><a class="double-link" href="https://github.com/pynamodb/PynamoDB/commit/<a class="double-link" href="https://github.com/pynamodb/PynamoDB/commit/5426ed9081e91316b214d6c10b447cfa1da8b0af">5426ed908</a>">5426ed908</a><a href="https://github.com/pynamodb/PynamoDB/commit/63b01ecf8987ed98e92d78c6abb8c94520ad6236">, users found themselves having to write some rather unergonomic code to reconcile Python&#39;s and a type-checker&#39;s perspectives:

    if TYPE_CHECKING:
        _MyModelGSI = GlobalSecondaryIndex[&quot;MyModel&quot;]
    else:
        _MyModelGSI = GlobalSecondaryIndex

    class MyModelUserIdGSI(_MyModelGSI):
        &quot;&quot;&quot;A GSI for looking up by user ID.&quot;&quot;&quot;
       ...

    class MyModelEmailGSI(_MyModelGSI):
        &quot;&quot;&quot;A GSI for looking up by email.&quot;&quot;&quot;
       ...

This addresses it by allowing users to rewrite this as:

    class MyModelUserIdGSI(GlobalSecondaryIndex[&quot;MyModel&quot;]):
        &quot;&quot;&quot;A GSI for looking up by user ID.&quot;&quot;&quot;
       ...

    class MyModelEmailGSI(GlobalSecondaryIndex[&quot;MyModel&quot;]):
        &quot;&quot;&quot;A GSI for looking up by email.&quot;&quot;&quot;
       ...

Since we maintain Python 2 compatibility, we cannot assume the typing module is available so we're making a mock Generic class instead.

2578 of 2704 relevant lines covered (95.34%)

4.75 hits per line