/usr/lib/kitty/kitty/options/definition.py:4116: SyntaxWarning: invalid escape sequence '\e' long_text='''

[Agathe Porte]

[ Impact ]

The package displays a warning when installing it or upgrading it
from a previous version. This warning can scare users who see it
in the terminal.

[ Test Plan ]

Try to install the patched package and verify that it still starts
fine. Check that the warning is gone when installing or upgrading
the package:

$ sudo dpkg -i ./kitty_xxx.deb # no warnings displayed during install
$ kitty # use as a terminal

[ Where problems could occur ]

Fixing the string wrongly can make the program behave wrongly.

[ Original Bug Report ]

Hello,

During the upgrade of kitty, I get the following warning:

Setting up kitty (0.32.2-1ubuntu0.1) ...
/usr/lib/kitty/kitty/options/definition.py:4116: SyntaxWarning: invalid escape sequence '\e'
  long_text='''

I this this file should be patched so the warning does not appear during upgrade.

[Agathe Porte (gagath)]

Seems to be patched in later versions, does not occur in an oracular chroot. Only needs to be fixed in Noble.

[Agathe Porte (gagath)]

Attached debdiff for Noble SRU update.

[Graham Inggs (ginggs)]

This FTBFS for me, it looks like the same error reported to Debian [1].
If you get it to build, please provide a log or link to a PPA build.

[1] https://bugs.debian.org/1074216

[Graham Inggs (ginggs)]

My mistake, I didn't realize I tried to build this package with a backport of python3.12 3.12.4.

It builds fine with python3.12 3.12.3 from Noble.

However, this means that kitty in Noble will likely FTBFS when python3.12 gets an update. Would you please look to see if it is feasible to backport the fix for the FTBFS in the same SRU?

[Agathe Porte (gagath)]

Attached v2 debdiff that will also fix the FTBFS with Python updates for the tarball DeprecationWarning (upstream cherry-pick).

[Graham Inggs (ginggs)]

Uploaded, thanks!

[Robie Basak (racb)]

In general this looks good.

> + * Backport upstream commit ecc44dffeb50746cc3e3019750226a80a50082a3
> + to fix test_ssh_leading_data with newer releases of Python

This sounds like it only affects tests, and thus is OK to add to the SRU without further analysis. However, I was unable to verify this in a few minutes, and you made no mention of it in the bug comments above. Are you sure that this affects tests only and regular use of the built binary package, and how can this be verified?

> [ Test Plan ]

> Try to install the patched package and verify that it still starts
> fine. Check that the warning is gone when installing or upgrading
> the package.

Please could you add a smoke test to the Test Plan, or if that is already being done with automatic tests, document how you have determined this? This would then help mitigate what you're already identified in your regression analysis.

It would also be nice to have dep3 headers in the quilt patches so that they can more easily be verified against upstream, but no need to re-upload just for that.

[Agathe Porte (gagath)]

Hello Robie,

> This sounds like it only affects tests, and thus is OK to add to the SRU
> without further analysis. However, I was unable to verify this in a few
> minutes, and you made no mention of it in the bug comments above. Are you sure
> that this affects tests only and regular use of the built binary package, and
> how can this be verified?

No, it fixes something that will fail during testing and was caught by an
upstream test that was run during build. The fix is an upstream cherry-pick
that fixes that. It is not related to the SRU, but was asked to be added
as well by Graham because the next SRU of Python would have broken it anyways.

> Please could you add a smoke test to the Test Plan, or if that is already
> being done with automatic tests, document how you have determined this? This
> would then help mitigate what you're already identified in your regression
> analysis.

I added a list of commands in the test plan. As I said you just have to install
the package and the warning is gone. Then I just use kitty as a regular
terminal.

> It would also be nice to have dep3 headers in the quilt patches so that they
> can more easily be verified against upstream, but no need to re-upload just
> for that.

Yes. However I do not see my package anymore in -proposed. If I need to do a
new upload, I can remove the git headers and use dep3 headers instead and
propose a new debdiff for someone to sponsor.

[Mauricio Faria de Oliveira (mfo)]

Hello Agathe, or anyone else affected,

Accepted kitty into noble-proposed. The package will build now and be available at https://launchpad.net/ubuntu/+source/kitty/0.32.2-1ubuntu0.2 in a few hours, and then in the -proposed repository.

Please help us by testing this new package. See https://wiki.ubuntu.com/Testing/EnableProposed for documentation on how to enable and use -proposed. Your feedback will aid us getting this update out to other Ubuntu users.

If this package fixes the bug for you, please add a comment to this bug, mentioning the version of the package you tested, what testing has been performed on the package and change the tag from verification-needed-noble to verification-done-noble. If it does not fix the bug for you, please add a comment stating that, and change the tag to verification-failed-noble. In either case, without details of your testing we will not be able to proceed.

Further information regarding the verification process can be found at https://wiki.ubuntu.com/QATeam/PerformingSRUVerification . Thank you in advance for helping!

N.B. The updated package will be released to -updates after the bug(s) fixed by this package have been verified and the package has been in -proposed for a minimum of 7 days.

[Ubuntu SRU Bot (ubuntu-sru-bot)]

All autopkgtests for the newly accepted kitty (0.32.2-1ubuntu0.2) for noble have finished running.
The following regressions have been reported in tests triggered by the package:

apport/2.28.1-0ubuntu3.1 (armhf)

Please visit the excuses page listed below and investigate the failures, proceeding afterwards as per the StableReleaseUpdates policy regarding autopkgtest regressions [1].

https://people.canonical.com/~ubuntu-archive/proposed-migration/noble/update_excuses.html#kitty

[1] https://wiki.ubuntu.com/StableReleaseUpdates#Autopkgtest_Regressions

Thank you!

[Andreas Hasenack (ahasenack)]

The autopkgtests are green now, this is just missing the verification via the test plan.

[Agathe Porte (gagath)]

Verified by following the test plan. Installing the 0.32.2-1ubuntu0.2 version in noble-proposed does not raise any warning, and the terminal can be used as expected.

[Brian Murray (brian-murray)]

At one point in time the SRU team had discussed leaving packages in -proposed which only fix warnings rather than requiring users to download updated packages for little benefit. But given that this is a universe package and was accepted / reviewed by other SRU team members I'll not worry about that.

[Launchpad Janitor (janitor)]

This bug was fixed in the package kitty - 0.32.2-1ubuntu0.2

---------------
kitty (0.32.2-1ubuntu0.2) noble; urgency=medium

  * Backport upstream commit 9eb82c600d4fc392717d6bf09242e19a6ce33ca2
    to fix SyntaxWarning on install (LP: #2073688)
  * Backport upstream commit ecc44dffeb50746cc3e3019750226a80a50082a3
    to fix test_ssh_leading_data with newer releases of Python

 -- Agathe Porte <email address hidden> Sun, 21 Jul 2024 15:36:42 +0900

[Brian Murray (brian-murray)]

The verification of the Stable Release Update for kitty has completed successfully and the package is now being released to -updates. Subsequently, the Ubuntu Stable Release Updates Team is being unsubscribed and will not receive messages about this bug report. In the event that you encounter a regression using the package from -updates please report a new bug using ubuntu-bug and tag the bug report regression-update so we can easily find any regressions.