Chore: fix marshmallow warnings

[ff137]

Resolves #2342

I used the acapy-marshmallow-upgrade tool created by @dbluhm (as described here: #1854 (comment)), which iterates over usages of marshmallow fields, to wrap deprecated arguments in a metadata dictionary.

The only hairy part to this task was the schemas defined in aries_cloudagent/messaging/valid.py:

INT_EPOCH = {"validate": IntEpoch(), "example": IntEpoch.EXAMPLE}
WHOLE_NUM = {"validate": WholeNumber(), "example": WholeNumber.EXAMPLE}
# etc ...

These definitions were used in marshmallow fields by calling e.g. fields.Int(..., **INT_EPOCH), which would be missed by the upgrade tool. Also, validate is a supported argument, while example should be moved to metadata.

To account for this, I refactored the schema specifications (using regex):

INT_EPOCH_VALIDATE = IntEpoch()
INT_EPOCH_EXAMPLE = IntEpoch.EXAMPLE

WHOLE_NUM_VALIDATE = WholeNumber()
WHOLE_NUM_EXAMPLE = WholeNumber.EXAMPLE
# etc ...

I then updated the imports, and replaced usages of **INT_EPOCH, for example, to validate=INT_EPOCH_VALIDATE, example=INT_EPOCH_EXAMPLE. Then could I run the marshmallow-upgrade tool created by dbluhm to correctly wrap examples in the metadata.

Additionally: upgrade marshmallow to latest (3.20)

[ff137]

1'108 marshmallow deprecation warnings reduced to 18 :-)
I'll review the remaining ones and add changes

[ff137]

There is now only 1 more marshmallow deprecation warning (that occurs 45 times?)

aries_cloudagent/admin/tests/test_admin_server.py: 45 warnings
   /opt/hostedtoolcache/Python/3.9.17/x64/lib/python3.9/site-packages/apispec/ext/marshmallow/field_converter.py:213: RemovedInMarshmallow4Warning: The 'missing' attribute of fields is deprecated. Use 'load_default' instead.
     default = field.missing

There's no usage of the missing attribute in the codebase, so perhaps it's arising from a dependency - hard to tell

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information

[dbluhm]

@ff137 looks like updating apispec (current version installed is 3.3.0; upstream is 6.3.0) should take care of those last warnings. Might be worth updating aiohttp-apispec along with it (current version installed is 2.2.1; upstream is 2.2.3). That being said, we can handle that in another PR.

[dbluhm]

Looks good! Glad the script I wrote was helpful. I seem to remember taking a similar tactic on those splatted kwargs from messaging.valid.

Heads up, @swcurran @usingtechnology, this is a big change by number of lines but behavior of these models is unchanged. I think we should merge this quickly since addressing merge conflicts could be a bit extra painful.

This should merge cleanly into the anoncreds-rs branch but the new models defined there would need some adjustment. I can assist there. Even if the models weren't adjusted immediately, we'll get warnings reported to help track them down later.

[swcurran]

I leave it to you to define how to merge into the anoncreds-rs branch.

[swcurran]

Oh and awesome to get these cleaned up — nice work!!

[usingtechnology]

I leave it to you to define how to merge into the anoncreds-rs branch.

@dbluhm - i am in the middle of a first PR to the anoncreds-rs branch (cleanup, basically). Let me get that in place then we can do a merge of all this work. holiday day here in BC but will see if I can get that PR up for review sometime today.