Changes to cocotb.log

[ktbarrett]

Removes the superfluous SimLog function and make the cocotb.log module private.

[codecov]

Codecov Report

Attention: 2 lines in your changes are missing coverage. Please review.

Comparison is base (e9f745e) 69.01% compared to head (71000ff) 68.97%.
Report is 1 commits behind head on master.

Files	Patch %	Lines
src/cocotb/clock.py	50.00%	1 Missing ⚠️
src/cocotb/triggers.py	50.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #3673      +/-   ##
==========================================
- Coverage   69.01%   68.97%   -0.05%     
==========================================
  Files          45       45              
  Lines        8076     8075       -1     
  Branches     2327     2327              
==========================================
- Hits         5574     5570       -4     
- Misses       1391     1394       +3     
  Partials     1111     1111              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[cmarqu]

https://github.com/cocotb/cocotb/blob/master/docs/source/rotating_logger.rst needs adaptations as well.
Ideally we would run the code as a test (like in https://github.com/cocotb/cocotb/blob/master/docs/source/quickstart.rst?plain=1#L41-L44) and only include (parts of) the file in the docs.

[ktbarrett]

Hmmm... okay. I guess we are providing the classes in cocotb.log as public interfaces. I guess this should stay public. Though I really don't like shadowing the module cocotb.log with the variable cocotb.log, so I might change the name to cocotb.logging instead.

[ktbarrett]

Odd...

Apparently, importing an object from a module also does an import of that module. And Python also fixes up relative modules import cocotb.logging into relative imports import .logging which brings in the name logging. So in cocotb/__init__.py when doing from cocotb.logging import ... the logging name is overwritten which was once the standard library logging module. Very very strange behavior IMO.

[cmarqu]

So the least surprising way would be to call it something like cocolog?

[ktbarrett]

Well it only matters in the implementation of this file and specifically only on the call to logging.getLogger in __init__.py. It's not an issue for the user.