Allow class creation via kwargs

[garthy]

Class creation is tedious

    ingress = IngressSecurityRule()
    ingress.protocol = 'all'
    ingress.source = '10.0.0.0/16'

    egress =  EgressSecurityRule()
    egress.protocol = 6
    egress.destination = '0.0.0.0/0'
    
    
    seclistdetails = CreateSecurityListDetails()
    seclistdetails.compartment_id = config["compartment_id"]
    seclistdetails.egress_security_rules = [egress]
    seclistdetails.ingress_security_rules = [ingress]
    seclistdetails.display_name = 'build'
    seclistdetails.vcn_id = vcnid
    vcn_client = VirtualNetworkClient(config)
    seclist = vcn_client.create_security_list(seclistdetails)

Using kwargs is much better

    seclistdetails = CreateSecurityListDetails(compartment_id=config["compartment_id"],
                                               egress_security_rules = [EgressSecurityRule(protocol=6,
                                                                                           destination='0.0.0.0/0')
                                               ],
                                               ingress_security_rules = [IngressSecurityRule(protocol='all',
                                                                                             source='10.0.0.0/16')],
                                               display_name = 'build',
                                               vcn_id = vcnid)

Signed-off-by: Garth Bushell garth@garthy.com

[numberoverzero]

Thanks for the pull request! This is a great usability improvement, and matches Python's typical constructor-based property initialization.

The only blocking request is moving to class-based decoration; the rest are stylistic.

I'll start on the CHANGELOG and update docs/examples to take advantage of the new syntax. Nice work!

[numberoverzero]

This is a nice solution!

I think we can expand the utility of this pattern a bit by moving the decorator to the class instead of the __init__ method. Then, we'll have a single place to inject additional post-processing in the future.

@util.apply_enhancements  # or some name to indicate generality
class SomeModel(object):
    def __init__(...)

The PEP for class decorators suggests this is 3.0+ only, but things work fine here with 2.7.12.

Testing also gets easier when the individual enhancements can be defined on their own, with the actual decorator simply applying each function. Since the decorator returns the original class, other decorators can be stacked above this one:

# model.py
@user_defined_decorator
@util.extend
class SomeModel(object):
    ...


# util.py
def kwarg_init(self, **kwargs):
    # TODO inspect via swagger_types
    pass


def extend_model(cls):
    cls.__init__ = kwargs_init
    return cls

[numberoverzero]

This is a small nitpick, but swapping the iteration to loop over swagger_types instead of kwargs.items() is slightly faster and provides a more thorough error message.

Right now this will only display the first unknown attribute, instead of all the unknown attributes. By iterating the swagger_types and popping known keys, kwargs will only be non-empty if there are unknown attributes. This could eventually include required/optional logic and fail fast on missing arguments.

Using a Sentinel to skip available but not provided swagger types:

missing = Sentinel("Missing")

for attr in self.swagger_types:
    value = kwargs.pop(attr, missing)
    if value is not missing:
        setattr(self, attr, value)
if kwargs:
    raise(...)

For 2.7/3+ compatibility, you'll probably want six.iterkeys in the raise.

[numberoverzero]

nit: typo in "atribute" and please use str.format().
There may some lingering usage of the traditional style, but those will eventually be replaced.

[numberoverzero]

You don't need to grab it in this review, but with the class decorator below we can move the use of formatted_flat_dict into the decorator as well; every model simply uses it for the same __repr__.

[nathan-vu]

Sorry for the delay in looping back on this - as of v1.3.10 of the SDK (released yesterday, 27 Nov) classes can be initialized using kwargs. Documentation has also been updated to reflect this (e.g. https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/api/index.html#oci.object_storage.models.CreateBucketDetails)

[nathan-vu]

Just looping back again - going to close out this pull request as the changes to support providing keyword arguments when initialising a model object are now in the SDK