Edgewall Software

Changes between Version 16 and Version 17 of TracDev/ApiChanges/1.1.2


Ignore:
Timestamp:
Apr 19, 2015, 7:42:30 PM (4 years ago)
Author:
Peter Suter
Comment:

Redirect to 1.1

Legend:

Unmodified
Added
Removed
Modified
  • TracDev/ApiChanges/1.1.2

    v16 v17  
    1 {{{#!div style="float: right; margin: 0 1em"
    2 ← [../1.1.1] | [../1.1.3] →
    3 }}}
    4 = Documenting API changes since 1.1.1 =
    5 
    6 {{{#!box info
    7 The next stable version of Trac will be named 1.2 and will contain the cumulative changes made in the successive 1.1.x releases.
    8 
    9 These notes reflect the current status for [milestone:1.1.2], in [source:trunk].
    10 
    11 Proposed changes are prefixed with an OPEN mark and the //paragraph is written in italics.//
    12 }}}
    13 
    14 [[PageOutline(2-4,Summary,inline)]]
    15 
    16 
    17 == Prerequisites ==
    18 
    19 **Only Python versions 2.6 and 2.7 are supported.**
    20 
    21 
    22 === Modified Dependencies ===
    23 
    24 ==== jQuery and jQuery UI (bundled)
    25 
    26 The bundled version of [http://jquery.com jQuery] will be **1.9 / 2.0** instead of 1.8.3 in Trac 1.1.1.
    27 
    28 See jQuery release notes for the corresponding major updates:
    29  - http://blog.jquery.com/2013/01/15/jquery-1-9-final-jquery-2-0-beta-migrate-final-released/
    30 
    31 OPEN //
    32 The bundled version of the full minified [http://jqueryui.com jQuery UI] package will be [http://jqueryui.com/docs/Changelog/1.10.1 1.10.1]. See #11019.
    33 //
    34 
    35 ==== Babel (optional)
    36 
    37 The internationalization support (i18) for Trac is depending on [http://babel.edgewall.org/ Babel], version 0.9.5 and later. Support has been added for Babel 1.0 through 1.3 (the most recent at the time of this release).
    38 
    39 
    40 ==== Genshi (mandatory)
    41 
    42 Genshi 0.6.x and 0.7 are supported.
    43 
    44 
    45 ==== Subversion (optional)
    46 
    47 Subversion 1.6 - 1.8 are supported.
    48 
    49 
    50 ==== Git (optional)
    51 
    52 Git 1.5.6 - 2.0 are supported.
    53 
    54 
    55 === New Dependencies ===
    56 
    57 None!
    58 
    59 
    60 == Detailed List of Developer Visible Changes #list
    61 
    62 [[TicketQuery(milestone=1.1.2,status=closed,apichanges!=,col=summary,rows=apichanges,group=component,format=table)]]
    63 
    64 == Other Modifications made to the 1.0 API ==
    65 
    66 Take the //will be removed in version 1.1.1// comments in the code seriously. The earlier the planned API changes in 1.1.x, the better (gives more time to plugin authors to adapt). TODO
    67 
    68 {{{#!comment
    69 === Modified Interfaces ===
    70 ==== `I...`            ^[source:trunk/trac/.../api.py@rev:highlighted-linenum#Lnum (1.0)] [source:branches/0.12-stable/trac/.../api.py@rev:rev:highlighted-linenum#Lnum (0.12)]^ ==== #I...r
    71 
    72 ...
    73 }}}
    74 
    75 === Database API Changes ===
    76 
    77 
    78 ==== `Environment.get_db_cnx` has been removed #get_db_cnx
    79 
    80 Following the [../0.12#get_db_cnx deprecation] made in 0.12, the method `Environment.get_db_cnx` has been removed.
    81 
    82 One should now only use the //context managers// for retrieving a database Connection
    83 in read or write mode.
    84  - a **read-only** Connection can be used to form queries:
    85    {{{#!python
    86    with env.db_query as db:
    87        ...
    88    }}}
    89    a `db` instance obtained the above way should only be used for executing //SELECT//
    90    queries
    91  - a **writable** Connection can be used to modify the database content in a transaction:
    92    {{{#!python
    93    with env.db_transaction as db:
    94        ...
    95    }}}
    96    a `db` instance obtained the above way can be used to execute //INSERT/UPDATE/DELETE//
    97    queries; they will be committed when the last such automatic transaction
    98    in the control flow completes successfully. See DatabaseApi for the full details.
    99 
    100 `Environment.get_read_db` and the decorators `@with_transaction(env)` and `env.with_transaction()` have been [../1.0#with_transaction deprecated] since Trac 1.0 and will be removed in Trac 1.3.1.
    101 
    102 
    103 ==== `db` parameters removed from function and method signatures
    104 
    105 With the introduction of `@with_transaction(env)` decorators in 0.12 and continuing with the introduction of the database connection context managers in 1.0, the `db` parameters passed as function and method arguments became [../0.12#Othernews deprecated].
    106 
    107 The `db` parameters have been removed from nearly all function and method signatures. The `db` arguments are still present on methods of `IEnvironmentParticipant` implementations, but are deprecated and should no longer be used. They will be removed in 1.3.1.
    108 
    109 
    110 ==== `ConnectionBase` class
    111 
    112 The `ConnectionBase` class defines an abstract interface that database backends must adhere to when implementing a `Connection` class.
    113 
    114 
    115 
    116 === Template and CSS changes
    117 
    118 `tt` tags are not support in HTML5 and have been replaced with `code` tags in Trac (#11094). The styling of `tt` and `code` tags is the same in Trac , but `code` tags should be used since the styling for `tt` tags will be removed in a future version of Trac.
    119 
    120 The `about.css` stylesheet has been removed and the rules contained in that stylesheet have been moved to `trac.css`. The table of environment information on the //Error// and //About// pages have been extracted to a new template `environment_info.html` and the markup and associated rules in the stylesheet have been significantly changed.
    121 
    122 //Many more changes to be added, depending on how details we want to get. TracUpgrade#CustomizedTemplates claims that changes to `id`s and CSS `class`es will be documented in ApiChanges.//
    123 
    124 
    125 == New in the 1.1.2 API ==
    126 
    127 Be sure to have a look at the new ApiDocs ([http://www.edgewall.org/docs/trac-trunk/html/ for latest trunk]).
    128 
    129 //This is a work in progress - coverage is still not yet complete.//
    130 
    131 
    132 {{{#!comment
    133 === New Classes ===
    134 ==== `trac.x.y.ClassName` ^[source:trunk/trac/x/y.py@#Lnum (1.0)]^ ==== #ClassName
    135 
    136 ...
    137 
    138 === New Interfaces ===
    139 ==== `trac.x.y.IClassName` ^[source:trunk/trac/x/y.py@#Lnum (1.0)]^ ==== #IClassName
    140 
    141 
    142 === Other news ===
    143 
    144 }}}
     1See [../1.1]