app/soc/views/helpers/template_helpers.py
author Todd Larsen <tlarsen@google.com>
Thu, 28 Aug 2008 21:30:55 +0000
changeset 113 26d86de67714
child 125 155f43a0fa68
permissions -rw-r--r--
Helpers for manipulating templates and template search paths. Patch by: Todd Larsen Review by: to-be-reviewed
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
113
26d86de67714 Helpers for manipulating templates and template search paths.
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
     1
#!/usr/bin/python2.5
26d86de67714 Helpers for manipulating templates and template search paths.
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
     2
#
26d86de67714 Helpers for manipulating templates and template search paths.
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
     3
# Copyright 2008 the Melange authors.
26d86de67714 Helpers for manipulating templates and template search paths.
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
     4
#
26d86de67714 Helpers for manipulating templates and template search paths.
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
     5
# Licensed under the Apache License, Version 2.0 (the "License");
26d86de67714 Helpers for manipulating templates and template search paths.
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
     6
# you may not use this file except in compliance with the License.
26d86de67714 Helpers for manipulating templates and template search paths.
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
     7
# You may obtain a copy of the License at
26d86de67714 Helpers for manipulating templates and template search paths.
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
     8
#
26d86de67714 Helpers for manipulating templates and template search paths.
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
     9
#   http://www.apache.org/licenses/LICENSE-2.0
26d86de67714 Helpers for manipulating templates and template search paths.
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    10
#
26d86de67714 Helpers for manipulating templates and template search paths.
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    11
# Unless required by applicable law or agreed to in writing, software
26d86de67714 Helpers for manipulating templates and template search paths.
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    12
# distributed under the License is distributed on an "AS IS" BASIS,
26d86de67714 Helpers for manipulating templates and template search paths.
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    13
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
26d86de67714 Helpers for manipulating templates and template search paths.
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    14
# See the License for the specific language governing permissions and
26d86de67714 Helpers for manipulating templates and template search paths.
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    15
# limitations under the License.
26d86de67714 Helpers for manipulating templates and template search paths.
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    16
26d86de67714 Helpers for manipulating templates and template search paths.
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    17
"""Helpers for manipulating templates.
26d86de67714 Helpers for manipulating templates and template search paths.
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    18
"""
26d86de67714 Helpers for manipulating templates and template search paths.
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    19
26d86de67714 Helpers for manipulating templates and template search paths.
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    20
__authors__ = [
26d86de67714 Helpers for manipulating templates and template search paths.
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    21
  '"Todd Larsen" <tlarsen@google.com>',
26d86de67714 Helpers for manipulating templates and template search paths.
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    22
  ]
26d86de67714 Helpers for manipulating templates and template search paths.
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    23
26d86de67714 Helpers for manipulating templates and template search paths.
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    24
26d86de67714 Helpers for manipulating templates and template search paths.
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    25
def makeSiblingTemplatesList(templates, new_template_file):
26d86de67714 Helpers for manipulating templates and template search paths.
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    26
  """Converts template paths into a list of "sibling" templates.
26d86de67714 Helpers for manipulating templates and template search paths.
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    27
  
26d86de67714 Helpers for manipulating templates and template search paths.
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    28
  Args:
26d86de67714 Helpers for manipulating templates and template search paths.
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    29
    templates: search list of templates (or just a single template not in a
26d86de67714 Helpers for manipulating templates and template search paths.
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    30
      list) from which template paths will be extracted (discarding the final
26d86de67714 Helpers for manipulating templates and template search paths.
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    31
      template file name of each template)
26d86de67714 Helpers for manipulating templates and template search paths.
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    32
    new_template_file: new "sibling" template file to append to each extracted
26d86de67714 Helpers for manipulating templates and template search paths.
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    33
      template path
26d86de67714 Helpers for manipulating templates and template search paths.
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    34
      
26d86de67714 Helpers for manipulating templates and template search paths.
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    35
  Returns:
26d86de67714 Helpers for manipulating templates and template search paths.
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    36
    A list of potential "sibling" templates named by new_template_file located
26d86de67714 Helpers for manipulating templates and template search paths.
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    37
    in the paths of the templates in the supplied list.  For example, from:
26d86de67714 Helpers for manipulating templates and template search paths.
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    38
      ['foo/bar/the_old_template.html', 'foo/the_old_template.html']
26d86de67714 Helpers for manipulating templates and template search paths.
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    39
    to:
26d86de67714 Helpers for manipulating templates and template search paths.
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    40
      ['foo/bar/some_new_template.html', 'foo/some_new_template.html']
26d86de67714 Helpers for manipulating templates and template search paths.
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    41
  """
26d86de67714 Helpers for manipulating templates and template search paths.
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    42
  if not isinstance(templates, (list, tuple)):
26d86de67714 Helpers for manipulating templates and template search paths.
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    43
    templates = [templates]
26d86de67714 Helpers for manipulating templates and template search paths.
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    44
26d86de67714 Helpers for manipulating templates and template search paths.
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    45
  return [
26d86de67714 Helpers for manipulating templates and template search paths.
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    46
      '%s/%s' % (t.rsplit('/', 1)[0], new_template_file) for t in templates]