[RFC] Some refactoring

[akstrfn]

Is is not planned to change the behaviour nor modify the architecture. Some planned stuff, let me know what you think.

• [x] Rename Exception to BaseException
• [x] Make properties explicit
• [x] Remove Wrap __*slice__ methods
• [x] Improve documentation
  • [x] Update readme (add install method based on Plug?)
  • [x] Setup spinx docs
• [x] Reuse code from superclasses
  • [x] start in checkbox.py and headings.py
• [x] Use iterators/generators where possible
  • [x] flatten_list as generator
  • [x] start propery (dom_obj.py)
  • [x] filter_tems as filter iterator
  • [x] use enumerate where possible
• [x] Clean up todo plugin
• [x] Define work packages (todo's inside code)

[Ron89]

Thanks for the work improving memory efficiency and in reducing the code redundancy. Regarding to your TODO Shouldn't there be and error when values is not int?, is there scenarios when level can be not int?

And, though I do understand the name Exception might be too broad... Why BaseException?

PS. From the look of it, I think we should wait before you finishing the refactoring before pulling in?

[akstrfn]

Hi @Ron89, I don't think that there are any scenarios when _level shouldn't be int but it never will be because the getter will return integer. The thing is this allows for use of something like this something.level = '01' which makes the things implicit and that can lead to errors. I didn't want to change the behaviour of this for now.

As for Exceptions, I guessed that current code was trying to catch any exception hence before all exceptions were derived from Exception but now that is not the case, hence I changed it to BaseException

I am still working on it so don't pull it yet. I had quite a bit of problems with __*slice__ methods because of the way python 2 uses them.

[akstrfn]

It seems that this refactoring has broken the alignment, luckily I tested it because of PR #239 fixed