syntax highlighting dependency cleanup

[anonymous]

Enscript will highlight php as of 1.6.4, pygments is default for syntax highlighting.

1. Drop the php mimeviewer completely. There is no reason why php-cli should be required for trac-svn browsing of php code (either use enscript or pygment)

2. add pygment dep suggestion/requirement

[Christian Boos]

We could certainly deprecate the Enscript and PHP highlighters, yes.

[Remy Blank]

Replying to cboos:

We could certainly deprecate the Enscript and PHP highlighters, yes.

How would we do that? I suppose we would document it, but also add a warning in the log? Move the highlighters to tracopt?

[Christian Boos]

Deprecate with a (single) warning in 0.11.6 and move the highlighters to tracopt in trunk?

[Remy Blank]

Ok. Maybe a bit brutal, but hey, life's unfair ;-)

[Remy Blank]

Is this what you had in mind for 0.11.6?

trac/mimeview/enscript.py

@@ -119 +119 @@
 
     def __init__(self):
         self._types = None
+        self._deprecation_shown = False
 
     # IHTMLPreviewRenderer methods
 
@@ -132 +133 @@
         return self._types.get(mimetype, (None, 0))[1]
 
     def render(self, context, mimetype, content, filename=None, rev=None):
+        if not self._deprecation_shown:
+            self.log.warning('The Enscript highlighter is deprecated and '
+                             'will be disabled by default in 0.12')
+            self._deprecation_show = True
+
         cmdline = self.path
         mimetype = mimetype.split(';', 1)[0] # strip off charset
         mode = self._types[mimetype][0]

trac/mimeview/php.py

@@ -71 +71 @@
 
     returns_source = True
 
+    _deprecation_shown = False
+
     # IHTMLPreviewRenderer methods
 
     def get_quality_ratio(self, mimetype):
@@ -79 +81 @@
         return 0
 
     def render(self, context, mimetype, content, filename=None, rev=None):
+        if not self._deprecation_shown:
+            self.log.warning('The PHP highlighter is deprecated and will be '
+                             'disabled by default in 0.12')
+            self._deprecation_show = True
+
         # -n to ignore php.ini so we're using default colors
         cmdline = '%s -sn' % self.path
         self.env.log.debug("PHP command line: %s" % cmdline)

[Christian Boos]

Yes, except that if you replace:

if not self._deprecation_shown:

by:

if not hasattr(self, '_deprecation_shown'):

you get a smaller diff ;-)

[Remy Blank]

Right. But I tend to avoid hasattr() / getattr() magic whenever possible. I find them to be less readable.

About moving the components to tracopt, that means we also move the unit and functional tests, so we will have to auto-enable components in tracopt.* in the test suite.

[Remy Blank]

Warning added in [8799].

[Remy Blank]

Moved the Enscript and PHP renderers into tracopt in [8802], together with the test suite for the PHP renderer.

[Ryan J Ollos]

It has been proposed to remove the Enscript, SilverCity and PHP renderers in comment:30:ticket:11605 for milestone:1.1.3. Please let me know if you have any thoughts.

[Ryan J Ollos]

Replying to rjollos:

It has been proposed to remove the Enscript, SilverCity and PHP renderers in comment:30:ticket:11605 for milestone:1.1.3. Please let me know if you have any thoughts.

Dedicated ticket is now #11795.