Changeset - fc6b1b0e1096
Parent rev.
Child rev.
[Not reviewed]
default
0 4 0
Thomas De Schampheleire - 9 years ago 2017-01-27 21:31:37
thomas.de.schampheleire@gmail.com
ini: set 'debug' only in one place

In Pylons-based Kallithea, the 'debug' option was set first in [DEFAULTS]
and then overridden with 'set debug = X' in [app:main]. Even when the value
under [DEFAULTS] was commented out, the use of the 'set' keyword (providing
override semantics) was required, because a default value for the global
'debug' was provided in the framework.

The presence of these two debug assignments is confusing.
Moreover, TurboGears2 makes the situation more easy and does not expect
'debug' to be in [DEFAULTS] nor does it provide a default at that level.
As a result, we can simple use 'debug = X' under [app:main].

Additionally, clarify the Big Fat Warning: the wording 'the line below' is
ambiguous and could be misunderstood in an ini file that had previously been
changed.
4 files changed with 10 insertions and 13 deletions:
development.ini
4
5
kallithea/lib/paster_commands/template.ini.mako
2
3
kallithea/tests/test.ini
2
3
scripts/generate-ini.py
2
2
0 comments (0 inline, 0 general)
development.ini
➞
Show inline comments
 
################################################################################
 
################################################################################
 
# Kallithea - Development config:                                              #
 
# listening on *:5000                                                          #
 
# sqlite and kallithea.db                                                      #
 
# initial_repo_scan = true                                                     #
 
# set debug = true                                                             #
 
# debug = true                                                                 #
 
# verbose and colorful logging                                                 #
 
#                                                                              #
 
# The %(here)s variable will be replaced with the parent directory of this file#
 
################################################################################
 
################################################################################
 

			




	
	
	
		
 
[DEFAULT]

			




	
	
	
		
 
debug = true

			




	
	
	
		
 

			




	
	
	
		
 
################################################################################

			




	
	
	
		
 
## Email settings                                                             ##

			




	
	
	
		
 
##                                                                            ##

			




	
	
	
		
 
## Refer to the documentation ("Email settings") for more details.            ##

			




	
	
	
		
 
##                                                                            ##

			




	
	
	
		
 
## It is recommended to use a valid sender address that passes access         ##

			




	
	
	
		
 
## validation and spam filtering in mail servers.                             ##

			




	
	
	
		
 
################################################################################

			




	
	
	
		
 

			




	
	
	
		
 
## 'From' header for application emails. You can optionally add a name.

			




	
	
	
		
 
## Default:

			




	
	
	
		
 
#app_email_from = Kallithea

			




	
	
	
		
 
## Examples:

			




	
	
	
		
 
#app_email_from = Kallithea <kallithea-noreply@example.com>

			




	
	
	
		
 
#app_email_from = kallithea-noreply@example.com

			




	
	
	
		
 

			




	
	
	
		
 
## Subject prefix for application emails.

			




	
	
	
		
 
## A space between this prefix and the real subject is automatically added.

			




	
	
	
		
 
## Default:

			




	
	
	
		
 
#email_prefix =

			




	
	
	
		
 
## Example:

			




	
	
	
		
 
#email_prefix = [Kallithea]

			




	
	
	
		
 

			




	
	
		
 
@@ -445,54 +444,54 @@ appenlight.request_keys_blacklist =

			




	
	
	
		
 
## list of namespaces that should be ignores when gathering log entries

			




	
	
	
		
 
## can be string with comma separated list of namespaces

			




	
	
	
		
 
## (by default the client ignores own entries: appenlight_client.client)

			




	
	
	
		
 
appenlight.log_namespace_blacklist =

			




	
	
	
		
 

			




	
	
	
		
 
################

			




	
	
	
		
 
### [sentry] ###

			




	
	
	
		
 
################

			




	
	
	
		
 

			




	
	
	
		
 
## sentry is a alternative open source error aggregator

			




	
	
	
		
 
## you must install python packages `sentry` and `raven` to enable

			




	
	
	
		
 

			




	
	
	
		
 
sentry.dsn = YOUR_DNS

			




	
	
	
		
 
sentry.servers =

			




	
	
	
		
 
sentry.name =

			




	
	
	
		
 
sentry.key =

			




	
	
	
		
 
sentry.public_key =

			




	
	
	
		
 
sentry.secret_key =

			




	
	
	
		
 
sentry.project =

			




	
	
	
		
 
sentry.site =

			




	
	
	
		
 
sentry.include_paths =

			




	
	
	
		
 
sentry.exclude_paths =

			




	
	
	
		
 

			




	
	
	
		
 
################################################################################

			




	
	
	
		
 
## WARNING: *THE LINE BELOW MUST BE UNCOMMENTED ON A PRODUCTION ENVIRONMENT*  ##

			




	
	
	
		
 
## WARNING: *DEBUG MODE MUST BE OFF IN A PRODUCTION ENVIRONMENT*              ##

			




	
	
	
		
 
## Debug mode will enable the interactive debugging tool, allowing ANYONE to  ##

			




	
	
	
		
 
## execute malicious code after an exception is raised.                       ##

			




	
	
	
		
 
################################################################################

			




	
	
	
		
 
#set debug = false

			




	
	
	
		
 
set debug = true

			




	
	
	
		
 
#debug = false

			




	
	
	
		
 
debug = true

			




	
	
	
		
 

			




	
	
	
		
 
##################################

			




	
	
	
		
 
###       LOGVIEW CONFIG       ###

			




	
	
	
		
 
##################################

			




	
	
	
		
 

			




	
	
	
		
 
logview.sqlalchemy = #faa

			




	
	
	
		
 
logview.pylons.templating = #bfb

			




	
	
	
		
 
logview.pylons.util = #eee

			




	
	
	
		
 

			




	
	
	
		
 
#########################################################

			




	
	
	
		
 
### DB CONFIGS - EACH DB WILL HAVE IT'S OWN CONFIG    ###

			




	
	
	
		
 
#########################################################

			




	
	
	
		
 

			




	
	
	
		
 
# SQLITE [default]

			




	
	
	
		
 
sqlalchemy.url = sqlite:///%(here)s/kallithea.db?timeout=60

			




	
	
	
		
 

			




	
	
	
		
 
# POSTGRESQL

			




	
	
	
		
 
#sqlalchemy.url = postgresql://user:pass@localhost/kallithea

			




	
	
	
		
 

			




	
	
	
		
 
# MySQL

			




	
	
	
		
 
#sqlalchemy.url = mysql://user:pass@localhost/kallithea?charset=utf8

			




	
	
	
		
 

			




	
	
	
		
 
# see sqlalchemy docs for others

			




	
	
	
		
 

			




        

    


    
    

    

        

                

                    kallithea/lib/paster_commands/template.ini.mako
                

                

                  
                      
                        

                      ➞

                      
                        
                  

                  
                      
                  
                      
                  
                      
                  
                      
                  
                  
                

                

                    Show inline comments
                    
                

        

        

            



	
	
	
		
 
## -*- coding: utf-8 -*-

			




	
	
	
		
 
<%text>################################################################################</%text>

			




	
	
	
		
 
<%text>################################################################################</%text>

			




	
	
	
		
 
# Kallithea - config file generated with kallithea-config                      #

			




	
	
	
		
 
<%text>################################################################################</%text>

			




	
	
	
		
 
<%text>################################################################################</%text>

			




	
	
	
		
 

			




	
	
	
		
 
[DEFAULT]

			




	
	
	
		
 
debug = true

			




	
	
	
		
 

			




	
	
	
		
 
<%text>################################################################################</%text>

			




	
	
	
		
 
<%text>## Email settings                                                             ##</%text>

			




	
	
	
		
 
<%text>##                                                                            ##</%text>

			




	
	
	
		
 
<%text>## Refer to the documentation ("Email settings") for more details.            ##</%text>

			




	
	
	
		
 
<%text>##                                                                            ##</%text>

			




	
	
	
		
 
<%text>## It is recommended to use a valid sender address that passes access         ##</%text>

			




	
	
	
		
 
<%text>## validation and spam filtering in mail servers.                             ##</%text>

			




	
	
	
		
 
<%text>################################################################################</%text>

			




	
	
	
		
 

			




	
	
	
		
 
<%text>## 'From' header for application emails. You can optionally add a name.</%text>

			




	
	
	
		
 
<%text>## Default:</%text>

			




	
	
	
		
 
#app_email_from = Kallithea

			




	
	
	
		
 
<%text>## Examples:</%text>

			




	
	
	
		
 
#app_email_from = Kallithea <kallithea-noreply@example.com>

			




	
	
	
		
 
#app_email_from = kallithea-noreply@example.com

			




	
	
	
		
 

			




	
	
	
		
 
<%text>## Subject prefix for application emails.</%text>

			




	
	
	
		
 
<%text>## A space between this prefix and the real subject is automatically added.</%text>

			




	
	
	
		
 
<%text>## Default:</%text>

			




	
	
	
		
 
#email_prefix =

			




	
	
	
		
 
<%text>## Example:</%text>

			




	
	
	
		
 
#email_prefix = [Kallithea]

			




	
	
	
		
 

			




	
	
		
 
@@ -446,53 +445,53 @@ appenlight.request_keys_blacklist =

			




	
	
	
		
 
<%text>## (by default the client ignores own entries: appenlight_client.client)</%text>

			




	
	
	
		
 
appenlight.log_namespace_blacklist =

			




	
	
	
		
 

			




	
	
	
		
 
%elif error_aggregation_service == 'sentry':

			




	
	
	
		
 
<%text>################</%text>

			




	
	
	
		
 
<%text>### [sentry] ###</%text>

			




	
	
	
		
 
<%text>################</%text>

			




	
	
	
		
 

			




	
	
	
		
 
<%text>## sentry is a alternative open source error aggregator</%text>

			




	
	
	
		
 
<%text>## you must install python packages `sentry` and `raven` to enable</%text>

			




	
	
	
		
 

			




	
	
	
		
 
sentry.dsn = YOUR_DNS

			




	
	
	
		
 
sentry.servers =

			




	
	
	
		
 
sentry.name =

			




	
	
	
		
 
sentry.key =

			




	
	
	
		
 
sentry.public_key =

			




	
	
	
		
 
sentry.secret_key =

			




	
	
	
		
 
sentry.project =

			




	
	
	
		
 
sentry.site =

			




	
	
	
		
 
sentry.include_paths =

			




	
	
	
		
 
sentry.exclude_paths =

			




	
	
	
		
 

			




	
	
	
		
 
%endif

			




	
	
	
		
 
<%text>################################################################################</%text>

			




	
	
	
		
 
<%text>## WARNING: *THE LINE BELOW MUST BE UNCOMMENTED ON A PRODUCTION ENVIRONMENT*  ##</%text>

			




	
	
	
		
 
<%text>## WARNING: *DEBUG MODE MUST BE OFF IN A PRODUCTION ENVIRONMENT*              ##</%text>

			




	
	
	
		
 
<%text>## Debug mode will enable the interactive debugging tool, allowing ANYONE to  ##</%text>

			




	
	
	
		
 
<%text>## execute malicious code after an exception is raised.                       ##</%text>

			




	
	
	
		
 
<%text>################################################################################</%text>

			




	
	
	
		
 
set debug = false

			




	
	
	
		
 
debug = false

			




	
	
	
		
 

			




	
	
	
		
 
<%text>##################################</%text>

			




	
	
	
		
 
<%text>###       LOGVIEW CONFIG       ###</%text>

			




	
	
	
		
 
<%text>##################################</%text>

			




	
	
	
		
 

			




	
	
	
		
 
logview.sqlalchemy = #faa

			




	
	
	
		
 
logview.pylons.templating = #bfb

			




	
	
	
		
 
logview.pylons.util = #eee

			




	
	
	
		
 

			




	
	
	
		
 
<%text>#########################################################</%text>

			




	
	
	
		
 
<%text>### DB CONFIGS - EACH DB WILL HAVE IT'S OWN CONFIG    ###</%text>

			




	
	
	
		
 
<%text>#########################################################</%text>

			




	
	
	
		
 

			




	
	
	
		
 
%if database_engine == 'sqlite':

			




	
	
	
		
 
# SQLITE [default]

			




	
	
	
		
 
sqlalchemy.url = sqlite:///${here}/kallithea.db?timeout=60

			




	
	
	
		
 

			




	
	
	
		
 
%elif database_engine == 'postgres':

			




	
	
	
		
 
# POSTGRESQL

			




	
	
	
		
 
sqlalchemy.url = postgresql://user:pass@localhost/kallithea

			




	
	
	
		
 

			




	
	
	
		
 
%elif database_engine == 'mysql':

			




	
	
	
		
 
# MySQL

			




	
	
	
		
 
sqlalchemy.url = mysql://user:pass@localhost/kallithea?charset=utf8

			




        

    


    
    

    

        

                

                    kallithea/tests/test.ini
                

                

                  
                      
                        

                      ➞

                      
                        
                  

                  
                      
                  
                      
                  
                      
                  
                      
                  
                  
                

                

                    Show inline comments
                    
                

        

        

            



	
	
	
		
 
################################################################################

			




	
	
	
		
 
################################################################################

			




	
	
	
		
 
# Kallithea - config for tests:                                                #

			




	
	
	
		
 
# initial_repo_scan = true                                                     #

			




	
	
	
		
 
# sqlalchemy and kallithea_test.sqlite                                         #

			




	
	
	
		
 
# custom logging                                                               #

			




	
	
	
		
 
#                                                                              #

			




	
	
	
		
 
# The %(here)s variable will be replaced with the parent directory of this file#

			




	
	
	
		
 
################################################################################

			




	
	
	
		
 
################################################################################

			




	
	
	
		
 

			




	
	
	
		
 
[DEFAULT]

			




	
	
	
		
 
debug = true

			




	
	
	
		
 

			




	
	
	
		
 
################################################################################

			




	
	
	
		
 
## Email settings                                                             ##

			




	
	
	
		
 
##                                                                            ##

			




	
	
	
		
 
## Refer to the documentation ("Email settings") for more details.            ##

			




	
	
	
		
 
##                                                                            ##

			




	
	
	
		
 
## It is recommended to use a valid sender address that passes access         ##

			




	
	
	
		
 
## validation and spam filtering in mail servers.                             ##

			




	
	
	
		
 
################################################################################

			




	
	
	
		
 

			




	
	
	
		
 
## 'From' header for application emails. You can optionally add a name.

			




	
	
	
		
 
## Default:

			




	
	
	
		
 
#app_email_from = Kallithea

			




	
	
	
		
 
## Examples:

			




	
	
	
		
 
#app_email_from = Kallithea <kallithea-noreply@example.com>

			




	
	
	
		
 
#app_email_from = kallithea-noreply@example.com

			




	
	
	
		
 

			




	
	
	
		
 
## Subject prefix for application emails.

			




	
	
	
		
 
## A space between this prefix and the real subject is automatically added.

			




	
	
	
		
 
## Default:

			




	
	
	
		
 
#email_prefix =

			




	
	
	
		
 
## Example:

			




	
	
	
		
 
#email_prefix = [Kallithea]

			




	
	
	
		
 

			




	
	
		
 
@@ -450,53 +449,53 @@ appenlight.request_keys_blacklist =

			




	
	
	
		
 
## list of namespaces that should be ignores when gathering log entries

			




	
	
	
		
 
## can be string with comma separated list of namespaces

			




	
	
	
		
 
## (by default the client ignores own entries: appenlight_client.client)

			




	
	
	
		
 
appenlight.log_namespace_blacklist =

			




	
	
	
		
 

			




	
	
	
		
 
################

			




	
	
	
		
 
### [sentry] ###

			




	
	
	
		
 
################

			




	
	
	
		
 

			




	
	
	
		
 
## sentry is a alternative open source error aggregator

			




	
	
	
		
 
## you must install python packages `sentry` and `raven` to enable

			




	
	
	
		
 

			




	
	
	
		
 
sentry.dsn = YOUR_DNS

			




	
	
	
		
 
sentry.servers =

			




	
	
	
		
 
sentry.name =

			




	
	
	
		
 
sentry.key =

			




	
	
	
		
 
sentry.public_key =

			




	
	
	
		
 
sentry.secret_key =

			




	
	
	
		
 
sentry.project =

			




	
	
	
		
 
sentry.site =

			




	
	
	
		
 
sentry.include_paths =

			




	
	
	
		
 
sentry.exclude_paths =

			




	
	
	
		
 

			




	
	
	
		
 
################################################################################

			




	
	
	
		
 
## WARNING: *THE LINE BELOW MUST BE UNCOMMENTED ON A PRODUCTION ENVIRONMENT*  ##

			




	
	
	
		
 
## WARNING: *DEBUG MODE MUST BE OFF IN A PRODUCTION ENVIRONMENT*              ##

			




	
	
	
		
 
## Debug mode will enable the interactive debugging tool, allowing ANYONE to  ##

			




	
	
	
		
 
## execute malicious code after an exception is raised.                       ##

			




	
	
	
		
 
################################################################################

			




	
	
	
		
 
set debug = false

			




	
	
	
		
 
debug = false

			




	
	
	
		
 

			




	
	
	
		
 
##################################

			




	
	
	
		
 
###       LOGVIEW CONFIG       ###

			




	
	
	
		
 
##################################

			




	
	
	
		
 

			




	
	
	
		
 
logview.sqlalchemy = #faa

			




	
	
	
		
 
logview.pylons.templating = #bfb

			




	
	
	
		
 
logview.pylons.util = #eee

			




	
	
	
		
 

			




	
	
	
		
 
#########################################################

			




	
	
	
		
 
### DB CONFIGS - EACH DB WILL HAVE IT'S OWN CONFIG    ###

			




	
	
	
		
 
#########################################################

			




	
	
	
		
 

			




	
	
	
		
 
# SQLITE [default]

			




	
	
	
		
 
#sqlalchemy.url = sqlite:///%(here)s/kallithea.db?timeout=60

			




	
	
	
		
 
sqlalchemy.url = sqlite:///%(here)s/kallithea_test.sqlite

			




	
	
	
		
 

			




	
	
	
		
 
# POSTGRESQL

			




	
	
	
		
 
#sqlalchemy.url = postgresql://user:pass@localhost/kallithea

			




	
	
	
		
 

			




	
	
	
		
 
# MySQL

			




	
	
	
		
 
#sqlalchemy.url = mysql://user:pass@localhost/kallithea?charset=utf8

			




	
	
	
		
 

			




	
	
	
		
 
# see sqlalchemy docs for others

			




        

    


    
    

    

        

                

                    scripts/generate-ini.py
                

                

                  
                      
                        

                      ➞

                      
                        
                  

                  
                      
                  
                      
                  
                      
                  
                      
                  
                  
                

                

                    Show inline comments
                    
                

        

        

            



	
	
		
 
@@ -51,60 +51,60 @@ ini_files = [

			




	
	
	
		
 
                'archive_cache_dir': '%(here)s/../../data/test/tarballcache',

			




	
	
	
		
 
                'beaker.cache.data_dir': '%(here)s/../../data/test/cache/data',

			




	
	
	
		
 
                'beaker.cache.lock_dir': '%(here)s/../../data/test/cache/lock',

			




	
	
	
		
 
                'sqlalchemy.url': 'sqlite:///%(here)s/kallithea_test.sqlite',

			




	
	
	
		
 
            },

			




	
	
	
		
 
            '[handler_console]': {

			




	
	
	
		
 
                'level': 'DEBUG',

			




	
	
	
		
 
                'formatter': 'color_formatter',

			




	
	
	
		
 
            },

			




	
	
	
		
 
            # The 'handler_console_sql' block is very similar to the one in

			




	
	
	
		
 
            # development.ini, but without the explicit 'level=DEBUG' setting:

			




	
	
	
		
 
            # it causes duplicate sqlalchemy debug logs, one through

			




	
	
	
		
 
            # handler_console_sql and another through another path.

			




	
	
	
		
 
            '[handler_console_sql]': {

			




	
	
	
		
 
                'formatter': 'color_formatter_sql',

			




	
	
	
		
 
            },

			




	
	
	
		
 
        },

			




	
	
	
		
 
    ),

			




	
	
	
		
 
    ('development.ini',

			




	
	
	
		
 
        '''

			




	
	
	
		
 
        Kallithea - Development config:

			




	
	
	
		
 
        listening on *:5000

			




	
	
	
		
 
        sqlite and kallithea.db

			




	
	
	
		
 
        initial_repo_scan = true

			




	
	
	
		
 
        set debug = true

			




	
	
	
		
 
        debug = true

			




	
	
	
		
 
        verbose and colorful logging

			




	
	
	
		
 

			




	
	
	
		
 
        The %(here)s variable will be replaced with the parent directory of this file

			




	
	
	
		
 
        ''',

			




	
	
	
		
 
        {

			




	
	
	
		
 
            '[server:main]': {

			




	
	
	
		
 
                'host': '0.0.0.0',

			




	
	
	
		
 
            },

			




	
	
	
		
 
            '[app:main]': {

			




	
	
	
		
 
                'initial_repo_scan': 'true',

			




	
	
	
		
 
                'set debug': 'true',

			




	
	
	
		
 
                'debug': 'true',

			




	
	
	
		
 
                'app_instance_uuid': 'development-not-secret',

			




	
	
	
		
 
                'beaker.session.secret': 'development-not-secret',

			




	
	
	
		
 
            },

			




	
	
	
		
 
            '[handler_console]': {

			




	
	
	
		
 
                'level': 'DEBUG',

			




	
	
	
		
 
                'formatter': 'color_formatter',

			




	
	
	
		
 
            },

			




	
	
	
		
 
            '[handler_console_sql]': {

			




	
	
	
		
 
                'level': 'DEBUG',

			




	
	
	
		
 
                'formatter': 'color_formatter_sql',

			




	
	
	
		
 
            },

			




	
	
	
		
 
        },

			




	
	
	
		
 
    ),

			




	
	
	
		
 
]

			




	
	
	
		
 

			




	
	
	
		
 

			




	
	
	
		
 
def main():

			




	
	
	
		
 
    # make sure all mako lines starting with '#' (the '##' comments) are marked up as <text>

			




	
	
	
		
 
    print 'reading:', makofile

			




	
	
	
		
 
    mako_org = file(makofile).read()

			




	
	
	
		
 
    mako_no_text_markup = re.sub(r'</?%text>', '', mako_org)

			




	
	
	
		
 
    mako_marked_up = re.sub(r'\n(##.*)', r'\n<%text>\1</%text>', mako_no_text_markup, flags=re.MULTILINE)

			




	
	
	
		
 
    if mako_marked_up != mako_org:

			




	
	
	
		
 
        print 'writing:', makofile

			




        

    



    


    



    



      

      





    
    0 comments (0 inline, 0 general)
    





    


  

  







  


    




    








    
        
    
    
        This site is powered by
            Kallithea 0.7.0,
        which is
        © 2010–2025 by various authors & licensed under GPLv3.