If a common message is not being used, they should each be treated separately with respect to choosing a marker function

[jingtao liang]

Follow the http://docs.openstack.org/developer/oslo.i18n/guidelines.html

For example, do not do this:

# WRONG
LOG.exception(_('There was an error.'))
raise LocalExceptionClass(_('An error occured.'))
Instead, use this style:

# RIGHT
LOG.exception(_LE('There was an error.'))
raise LocalExceptionClass(_('An error occured.'))

And oslo.log has the problem,we shuld correct it.

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/340329

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/340330

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/340330
Committed: https://git.openstack.org/cgit/openstack/oslo.log/commit/?id=c426a42ccd9cab3a7c657684b025475b78f8c330
Submitter: Jenkins
Branch: master

commit c426a42ccd9cab3a7c657684b025475b78f8c330
Author: liangjingtao <email address hidden>
Date: Mon Jul 11 20:12:36 2016 +0800

    Replace "LOG.exception(_" with "LOG.exception(_LE"

    Follow http://docs.openstack.org/developer/oslo.i18n/guidelines.html:
    If a common message is not being used, they should each betreated
    separately with respect to choosing a marker function.So this patch
    is to fix it.

    Change-Id: I07945d82320d9faf6dc452d49722af610330b441
    Closes-Bug: #1600788

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/340693

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/340894

[Doug Hellmann (doug-hellmann)]

This issue was fixed in the openstack/oslo.log 3.12.0 release.

[Brandon Logan (brandon-logan)]

for neutron, using the following grep does not return any violations:
$ grep -PRn --exclude-dir=.tox --exclude-dir=.testrepository 'LOG.exception\(_\(' .

Howver, there are some that create the message before doing the LOG.exception call and looks like some of those do the _(.

$ grep -PRn --exclude-dir=.tox --exclude-dir=.testrepository 'LOG.exception\([a-z]' .
./neutron/agent/linux/ip_lib.py:993: LOG.exception(msg, {'addr': address,
./neutron/agent/linux/iptables_manager.py:417: LOG.exception(msg)
./neutron/agent/l3/router_info.py:258: LOG.exception(msg)
./neutron/agent/l3/router_info.py:336: LOG.exception(msg)
./neutron/agent/l3/namespaces.py:83: LOG.exception(msg, self.name)
./neutron/agent/l3/dvr_local_router.py:319: LOG.exception(exc)
./neutron/agent/l3/agent.py:461: LOG.exception(msg, update.id)
./neutron/agent/l3/agent.py:484: LOG.exception(e.msg)
./neutron/agent/l3/agent.py:492: LOG.exception(msg, update.id)
./neutron/policy.py:207: LOG.exception(err_reason)

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/340894
Committed: https://git.openstack.org/cgit/openstack/glance/commit/?id=14ccf5986e0423a2835c2c5be8c9a1246f0db2f3
Submitter: Jenkins
Branch: master

commit 14ccf5986e0423a2835c2c5be8c9a1246f0db2f3
Author: weiweigu <email address hidden>
Date: Tue Jul 12 21:12:04 2016 +0800

    Replace "LOG.warn(_" with "LOG.(_LW"

    Follow http://docs.openstack.org/developer/oslo.i18n/guidelines.html:
    If a common message is not being used, they should each betreated
    separately with respect to choosing a marker function.So this patch
    is to fix it.

    Change-Id: Id122aa6395c534bee5287264c8951181f08d6f19
    Closes-Bug: #1600788

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/342616

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/342616
Committed: https://git.openstack.org/cgit/openstack/magnum/commit/?id=ec729d6cc686f0af5c79cfd24cac99fc3de215fd
Submitter: Jenkins
Branch: master

commit ec729d6cc686f0af5c79cfd24cac99fc3de215fd
Author: weiweigu <email address hidden>
Date: Fri Jul 15 15:26:02 2016 +0800

    Replace "LOG.info(_" with "LOG.info(_LI"

    Follow http://docs.openstack.org/developer/oslo.i18n/guidelines.html:
    If a common message is not being used, they should each betreated
    separately with respect to choosing a marker function.So this patch
    is to fix it.

    Change-Id: If7a74ce983ad0c7f4cab057cadd7d20ef3067fcd
    Closes-Bug: #1600788

[OpenStack Infra (hudson-openstack)]

Change abandoned by Nikhil Komawar (<email address hidden>) on branch: master
Review: https://review.openstack.org/340329
Reason: as per agreement

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/magnum 3.0.0 release.

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/glance 13.0.0.0b3 development milestone.

[OpenStack Infra (hudson-openstack)]

Change abandoned by gordon chung (<email address hidden>) on branch: master
Review: https://review.openstack.org/340693
Reason: stale

[Akihiro Motoki (amotoki)]

Horizon does not use oslo.log for logging. Horizon depends on Django and logging is also handled via django and python standard logging. In the horizon messaging policy, logging messages are not translated and other user visible message are translated via django translation marker. (Note that _ has a different meaning in horizon.)

There were similar situation in horizon, but it was clean up as bug 1406333.

Marking this as Won't Fix in horizon. In horizon there is nothing to do more.

[Mitya Eremeev (mitos)]

At the moment documentation is controversial.
I submitted a bug regarding the issue:
https://bugs.launchpad.net/oslo.i18n/+bug/1910526

[Akihiro Motoki (amotoki)]

Mitya, could you add a URL you submitted to neutron? "Fix Committed" means it has been fixed in the master branch, but I am not sure what you mean.

[Akihiro Motoki (amotoki)]

https://review.opendev.org/c/openstack/neutron/+/771501 looks a neturon commit.

[Mitya Eremeev (mitos)]

Hello, Akihiro,

you're right.

[Mitya Eremeev (mitos)]

JFYI,

tiny fix regarding the bug
https://review.opendev.org/c/openstack/neutron/+/774143