Avoid duplicate log messages in Jupyter

[lucas-flexcompute]

When a rich console is created within a jupyter notebook, it autodetects the environment and outputs log messages by default, which ends up duplicating our messages, because we already have a standard output by default. A flag can be set to false to inhbit the autodetection.

[lucas-flexcompute]

To test this out, this simple script running as a jupyter cell, ipython session, or a standalone python file should demonstrate the issue:

import tidy3d as td
td.set_logging_file("logfile.log")
td.log.warning("Issue some warning")

[tylerflex]

Thanks Lucas, I'm not sure I could detect the issue when I tried it in ipython. Could you explain? and also add this to the changelog as well? (just updated on pre/2.5, so you'll want to pull)

[lucas-flexcompute]

The issue only affects the jupyter interface. The other runners are not affected, that's part of the problem. I'm not at home now, but I can fix the PR and changelog tomorrow.

…

On Mon, Oct 30, 2023, 17:44 Tyler Hughes ***@***.***> wrote: Thanks Lucas, I'm not sure I could detect the issue when I tried it in ipython. Could you explain? and also add this to the changelog as well? (just updated on pre/2.5, so you'll want to pull) — Reply to this email directly, view it on GitHub <#1225 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/A4TL7OLRFFM5EQQQUGSJBB3YCAGTBAVCNFSM6AAAAAA6WTVVBSVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTOOBWGAYDQNRTGU> . You are receiving this because you authored the thread.Message ID: ***@***.***>

[lucas-flexcompute]

So here is the issue better explained. In the python/ipython terminal:

And in Jupyter:

The second message is a "helper" function of the rich console, which also prints log file messages when it detects the jupyter environment. This is fixed by setting the flag force_jupyter=False when creating a rich console for file output only.

[tylerflex]

Looks good, feel free to merge after adding a changelog under "fixed". thanks!