Dictionaries - Expanding Fields

[EmanuelFaria]

@petermr and @manny
Working on this test dictionary found here:
temp/eoCompound/disambig.xml

Tasks

1. Generate IDs for entries which contain only letters, numbers and underscores
2. Gather all dictionary metadata into a metadata element. I.e. create a child of dictionary called metadata (authors, contributors, etc)
3. Add descriptions for entries as children of entries, so that there can be more than one, as we do now with synonyms.
4. We need to determine if the synonyms in this dictionary are true synonyms, or just possible one.
5. Get wikipedia page entries. (There may be more than of those as well)
6. Move any non-entry elements into <metadata>.

Today we will write code to manage Task #1

• We begin by writing a simple test in py4ami/ami_dict.py called test_entry_id
• assert that dict_dir "test/resources/eoCompound" (exists)
• assert that the dictionary "test/resources/eoCompound/disambig.xml" exists
• create disambig_dict from the disambig.xml file and test for satisfactory creation
• We add documentation for this test: "Tests whether entries have ids, and (later creates default values)
• We begin a test to count how many entries exist currently. We have manually counted that there are 9 entries now, so we make that assertion in the test. The test passes, which means we can count, or that the software is working.
• We test that the entries have IDs (which there are none currently), so the test should fail (which it does at this point because we have not yet written the method).
• Now we write the method to add entry ids. (and comment our code for this method with a description: get's list of ids of s and returns a list of ids (which may be empty). It iteratively searches for IDs, and if it finds an ID, it adds it to the list
• We assert that there is an empty list (because we started with no IDs) and it passed
• We manually add an id to the dictionary and re-run the test, so it failed as we asserted there should be none.
• Then we assert that the ID we created exists, and it passed.
• This method, as it stands today, works so we commit it to github.