A codes.<tab> object for Sage's codes

[nathanncohen]

As the title says !

Nathann

CC: @dimpase @ppurka @vbraun

Component: coding theory

Author: Nathann Cohen

Branch/Commit: u/ncohen/15445 @ 349d7a2

Reviewer: Punarbasu Purkayastha

Issue created by migration from https://trac.sagemath.org/ticket/15445

[nathanncohen]

Branch: u/ncohen/15445

[sagetrac-git]

Commit: a583c02

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

[a583c02](https://github.com/sagemath/sagetrac-mirror/commit/a583c02)	trac #15445: adds a coding.codes_catalog module exported as codes.
[ce3c5d9](https://github.com/sagemath/sagetrac-mirror/commit/ce3c5d9)	trac #15445: clean the docstrings of sage.coding.guava

[ppurka]

comment:3

Maybe, also remove the other codes from the global namespace? You can try to post it on sage-devel and gather some opinions on whether it is a good idea to remove all the codes from the global namespace. It will probably also improve the startup time of sage by a bit.

[nathanncohen]

comment:4

They will tell me to put deprecation warnings everywhere for one year T_T

[ppurka]

comment:5

Replying to @nathanncohen:

They will tell me to put deprecation warnings everywhere for one year T_T

Ah yes! That solves it! Put deprecation everywhere. :D On a more serious note, it might be confusing if the codes are available both as, say, HammingCode and codes.HammingCode. So, it is better that something is done about it and a clean interface is provided.

I am actually quite happy to see a codes.<tab>. That keeps it clean and it is easy to remember. Instead of trying to remember all the individual codes, I only need to remember codes and then a tab will show me all the codes that are available in Sage.

[nathanncohen]

comment:6

OKayyyyyyyyy... Ticket updated, deprecation warnings added ! Waiting for a review :-P

Nathann

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

[fe875f7](https://github.com/sagemath/sagetrac-mirror/commit/fe875f7)	trac #15445: updates doctests to use codes.
[a1594e9](https://github.com/sagemath/sagetrac-mirror/commit/a1594e9)	trac #15445: deprecating the Code constructors imported into the global namespace
[c84b820](https://github.com/sagemath/sagetrac-mirror/commit/c84b820)	trac #15445: add CyclicCode to codes_catalog

[sagetrac-git]

Changed commit from a583c02 to fe875f7

[ppurka]

comment:8

This looks good to me. Can you add a doctest or two, against say, HammingCode and ReedSolomonCode just to illustrate that the interface has changed and that the deprecation warning is showed now?